DofPrimitiveStateView< dim, number, Value > Struct Template Reference

Developer Documentation: MeltPoolDG::CompressibleFlow::DofPrimitiveStateView< dim, number, Value > Struct Template Reference
Developer Documentation
MeltPoolDG::CompressibleFlow::DofPrimitiveStateView< dim, number, Value > Struct Template Reference

#include <state_views.hpp>

Inheritance diagram for MeltPoolDG::CompressibleFlow::DofPrimitiveStateView< dim, number, Value >:
[legend]
Collaboration diagram for MeltPoolDG::CompressibleFlow::DofPrimitiveStateView< dim, number, Value >:
[legend]

Public Types

using state_type = std::remove_cvref_t< Value >
 
- Public Types inherited from MeltPoolDG::CompressibleFlow::DofPrimitiveValueMixin< dim, Value::value_type, DofPrimitiveStateView< dim, number, Value > >
using Idx = PrimitiveVariableIndex< dim >
 

Public Member Functions

 DofPrimitiveStateView (Value &value_state, const MaterialPhaseData< number > &material_data)
 
 operator DofPrimitiveStateView< dim, number, const Value > ()
 
EquationOfState eos_type () const
 
Value & value () const
 
const MaterialPhaseData< number > & material () const
 
- Public Member Functions inherited from MeltPoolDG::CompressibleFlow::DofPrimitiveValueMixin< dim, Value::value_type, DofPrimitiveStateView< dim, number, Value > >
decltype(auto) pressure () const
 
decltype(auto) velocity (const unsigned int component) const
 
auto velocity () const
 
decltype(auto) temperature () const
 
- Public Member Functions inherited from MeltPoolDG::CompressibleFlow::MaterialMixin< DofPrimitiveStateView< dim, number, Value > >
decltype(auto) dynamic_viscosity () const
 
decltype(auto) thermal_conductivity () const
 
decltype(auto) heat_capacity_ratio () const
 
decltype(auto) specific_gas_constant () const
 
decltype(auto) specific_isobaric_heat () const
 
decltype(auto) specific_isochoric_heat () const
 
decltype(auto) stiffening_pressure () const
 
decltype(auto) heat_bound () const
 
decltype(auto) covolume () const
 
decltype(auto) reference_state_pressure () const
 
decltype(auto) reference_state_density () const
 
decltype(auto) reference_state_sound_speed () const
 

Private Attributes

Value * flow_state
 
const MaterialPhaseData< number > & material_data
 

Detailed Description

template<int dim, typename number, IsPrimitiveStateCompatible< dim > Value>
struct MeltPoolDG::CompressibleFlow::DofPrimitiveStateView< dim, number, Value >

View providing access to primitive variables stored in the underlying data structure. Further, the view provides access to the associated material data.

The underlying Value must provide a value_type and be compatible with the primitive variable access expected by PrimitiveDofValueMixin.

Template Parameters
dimSpatial dimension.
numberScalar floating point type.
ValueType of the data structure storing the primitive variables.

Member Typedef Documentation

◆ state_type

template<int dim, typename number , IsPrimitiveStateCompatible< dim > Value>
using MeltPoolDG::CompressibleFlow::DofPrimitiveStateView< dim, number, Value >::state_type = std::remove_cvref_t<Value>

Constructor & Destructor Documentation

◆ DofPrimitiveStateView()

template<int dim, typename number , IsPrimitiveStateCompatible< dim > Value>
MeltPoolDG::CompressibleFlow::DofPrimitiveStateView< dim, number, Value >::DofPrimitiveStateView ( Value &  value_state,
const MaterialPhaseData< number > &  material_data 
)
inline

Member Function Documentation

◆ eos_type()

template<int dim, typename number , IsPrimitiveStateCompatible< dim > Value>
EquationOfState MeltPoolDG::CompressibleFlow::DofPrimitiveStateView< dim, number, Value >::eos_type ( ) const
inline

◆ material()

template<int dim, typename number , IsPrimitiveStateCompatible< dim > Value>
const MaterialPhaseData< number > & MeltPoolDG::CompressibleFlow::DofPrimitiveStateView< dim, number, Value >::material ( ) const
inline

◆ operator DofPrimitiveStateView< dim, number, const Value >()

template<int dim, typename number , IsPrimitiveStateCompatible< dim > Value>
MeltPoolDG::CompressibleFlow::DofPrimitiveStateView< dim, number, Value >::operator DofPrimitiveStateView< dim, number, const Value > ( )
inline

◆ value()

template<int dim, typename number , IsPrimitiveStateCompatible< dim > Value>
Value & MeltPoolDG::CompressibleFlow::DofPrimitiveStateView< dim, number, Value >::value ( ) const
inline

Member Data Documentation

◆ flow_state

template<int dim, typename number , IsPrimitiveStateCompatible< dim > Value>
Value* MeltPoolDG::CompressibleFlow::DofPrimitiveStateView< dim, number, Value >::flow_state
mutableprivate

◆ material_data

template<int dim, typename number , IsPrimitiveStateCompatible< dim > Value>
const MaterialPhaseData<number>& MeltPoolDG::CompressibleFlow::DofPrimitiveStateView< dim, number, Value >::material_data
private

The documentation for this struct was generated from the following file: