DofValueView< dim, StateType > Struct Template Reference

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

#include <state_views.hpp>

Inheritance diagram for MeltPoolDG::CompressibleFlow::DofValueView< dim, StateType >:
[legend]
Collaboration diagram for MeltPoolDG::CompressibleFlow::DofValueView< dim, StateType >:
[legend]

Public Types

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

Public Member Functions

 DofValueView (StateType &state)
 
 operator DofValueView< dim, const StateType > ()
 
StateType & value () const
 
- Public Member Functions inherited from MeltPoolDG::CompressibleFlow::DofValueMixin< dim, StateType::value_type, DofValueView< dim, StateType > >
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
 

Private Attributes

StateType * flow_state
 

Detailed Description

template<int dim, IsConservedStateCompatible< dim > StateType>
struct MeltPoolDG::CompressibleFlow::DofValueView< dim, StateType >

View providing access to 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., velocity or specific total energy) via the corresponding mixin.

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, IsConservedStateCompatible< dim > StateType>
using MeltPoolDG::CompressibleFlow::DofValueView< dim, StateType >::state_type = std::remove_cvref_t<StateType>

Constructor & Destructor Documentation

◆ DofValueView()

template<int dim, IsConservedStateCompatible< dim > StateType>
MeltPoolDG::CompressibleFlow::DofValueView< dim, StateType >::DofValueView ( StateType &  state)
inline

Member Function Documentation

◆ operator DofValueView< dim, const StateType >()

template<int dim, IsConservedStateCompatible< dim > StateType>
MeltPoolDG::CompressibleFlow::DofValueView< dim, StateType >::operator DofValueView< dim, const StateType > ( )
inline

◆ value()

template<int dim, IsConservedStateCompatible< dim > StateType>
StateType & MeltPoolDG::CompressibleFlow::DofValueView< dim, StateType >::value ( ) const
inline

Member Data Documentation

◆ flow_state

template<int dim, IsConservedStateCompatible< dim > StateType>
StateType* MeltPoolDG::CompressibleFlow::DofValueView< dim, StateType >::flow_state
mutableprivate

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