DofStateView< dim, number, Value > Struct Template Reference

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

#include <state_views.hpp>

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

Public Types

using state_type = std::remove_cvref_t< Value >
 
- Public Types inherited from MeltPoolDG::CompressibleFlow::DofValueMixin< dim, Value::value_type, DofStateView< dim, number, Value > >
using Idx = ConservedVariableIndex< dim >
 

Public Member Functions

 DofStateView (Value &value_state, const MaterialPhaseData< number > &material_data)
 
 operator DofStateView< dim, number, const Value > ()
 
EquationOfState eos_type () const
 
Value & value () const
 
const MaterialPhaseData< number > & material () const
 
- Public Member Functions inherited from MeltPoolDG::Flow::EOSValueMixin< dim, Value::value_type, DofStateView< dim, number, Value > >
decltype(auto) pressure () const
 
decltype(auto) temperature () const
 
decltype(auto) speed_of_sound () const
 
decltype(auto) inner_energy_from_pressure (const ValueType &pressure) const
 
decltype(auto) specific_inner_energy () const
 
- Public Member Functions inherited from MeltPoolDG::CompressibleFlow::DofValueMixin< dim, Value::value_type, DofStateView< dim, number, Value > >
decltype(auto) density () const
 
decltype(auto) momentum (const unsigned int component) const
 
decltype(auto) momentum () const
 
decltype(auto) velocity (const unsigned int component) const
 
dealii::Tensor< 1, dim, ValueType > velocity () const
 
decltype(auto) total_energy () const
 
decltype(auto) specific_total_energy () const
 
- Public Member Functions inherited from MeltPoolDG::CompressibleFlow::MaterialMixin< DofStateView< 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) stiffening_pressure () const
 
decltype(auto) heat_bound () const
 
decltype(auto) covolume () const
 

Private Attributes

Value * flow_state
 
const MaterialPhaseData< number > & material_data
 

Detailed Description

template<int dim, typename number, IsConservedStateCompatible< dim > Value>
struct MeltPoolDG::CompressibleFlow::DofStateView< dim, number, Value >

View providing access to the conserved variables stored in the underlying data structure. Besides direct access to the conserved variables, it enables computation of primitive variables, thermodynamic quantities, and material properties via the provided EOS and material data.

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

Template Parameters
StateTypeType of the data structure storing the conserved variables.

Member Typedef Documentation

◆ state_type

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

Constructor & Destructor Documentation

◆ DofStateView()

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

Member Function Documentation

◆ eos_type()

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

◆ material()

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

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

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

◆ value()

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

Member Data Documentation

◆ flow_state

template<int dim, typename number , IsConservedStateCompatible< dim > Value>
Value* MeltPoolDG::CompressibleFlow::DofStateView< dim, number, Value >::flow_state
mutableprivate

◆ material_data

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

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