DofPrimitiveValueView< dim, StateType > Struct Template Reference

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

#include <state_views.hpp>

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

Public Types

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

Public Member Functions

 DofPrimitiveValueView (StateType &state)
 
 operator DofPrimitiveValueView< dim, const StateType > ()
 
StateType & value () const
 
- Public Member Functions inherited from MeltPoolDG::CompressibleFlow::DofPrimitiveValueMixin< dim, StateType::value_type, DofPrimitiveValueView< dim, StateType > >
decltype(auto) pressure () const
 
decltype(auto) velocity (const unsigned int component) const
 
auto velocity () const
 
decltype(auto) temperature () const
 

Private Attributes

StateType * flow_state
 

Detailed Description

template<int dim, IsPrimitiveStateCompatible< dim > StateType>
struct MeltPoolDG::CompressibleFlow::DofPrimitiveValueView< dim, StateType >

View providing access to the primitive variables stored in the underlying data structure.

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

Constructor & Destructor Documentation

◆ DofPrimitiveValueView()

template<int dim, IsPrimitiveStateCompatible< dim > StateType>
MeltPoolDG::CompressibleFlow::DofPrimitiveValueView< dim, StateType >::DofPrimitiveValueView ( StateType &  state)
inline

Member Function Documentation

◆ operator DofPrimitiveValueView< dim, const StateType >()

template<int dim, IsPrimitiveStateCompatible< dim > StateType>
MeltPoolDG::CompressibleFlow::DofPrimitiveValueView< dim, StateType >::operator DofPrimitiveValueView< dim, const StateType > ( )
inline

◆ value()

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

Member Data Documentation

◆ flow_state

template<int dim, IsPrimitiveStateCompatible< dim > StateType>
StateType* MeltPoolDG::CompressibleFlow::DofPrimitiveValueView< dim, StateType >::flow_state
mutableprivate

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