DofGradientView< dim, StateType > Struct Template Reference

Developer Documentation: MeltPoolDG::CompressibleFlow::DofGradientView< dim, StateType > Struct Template Reference

Developer Documentation

#include <state_views.hpp>

Inheritance diagram for MeltPoolDG::CompressibleFlow::DofGradientView< dim, StateType >:

Collaboration diagram for MeltPoolDG::CompressibleFlow::DofGradientView< dim, StateType >:

Public Member Functions
	DofGradientView (StateType &state)

	operator DofGradientView< dim, const StateType > ()

StateType &	gradient_value () const

Public Member Functions inherited from MeltPoolDG::CompressibleFlow::DofGradientMixin< dim, StateType::value_type::value_type, DofGradientView< dim, StateType > >
decltype(auto)	grad_density () const

decltype(auto)	grad_momentum (const unsigned int component) const

decltype(auto)	grad_momentum () const

decltype(auto)	grad_velocity (const unsigned int component, const ValueType &density, const ValueType &velocity_component) const

decltype(auto)	grad_velocity () const

decltype(auto)	grad_total_energy () const

decltype(auto)	grad_specific_total_energy (const ValueType &density, const ValueType &specific_total_energy) const

Private Attributes
StateType *	flow_state

Additional Inherited Members
Public Types inherited from MeltPoolDG::CompressibleFlow::DofGradientMixin< dim, StateType::value_type::value_type, DofGradientView< dim, StateType > >
using	Idx = ConservedVariableIndex< dim >

Detailed Description

template<int dim, IsConservedGradientCompatible< dim > StateType>
struct MeltPoolDG::CompressibleFlow::DofGradientView< dim, StateType >

View providing access to the gradients of the conserved variables stored in the underlying data structure. Besides direct access to the conserved variables, it enables computation of directly derived quantities (e.g., gradient of the velocity) via the corresponding mixin.

The underlying StateType must store the conserved variables in a tensor-like container indexed according to TensorStorageIndex<dim>.

Template Parameters

StateType Type of the data structure storing the gradients of the conserved variables.

Constructor & Destructor Documentation