DofValueAndGradientStateView< dim, number, Value, Gradient > Struct Template Reference
|
Developer Documentation
|
MeltPoolDG::CompressibleFlow::DofValueAndGradientStateView< dim, number, Value, Gradient > Struct Template Reference
#include <state_views.hpp>
Inheritance diagram for MeltPoolDG::CompressibleFlow::DofValueAndGradientStateView< dim, number, Value, Gradient >:
Collaboration diagram for MeltPoolDG::CompressibleFlow::DofValueAndGradientStateView< dim, number, Value, Gradient >:
Public Types | |
| using | state_type = std::remove_cvref_t< Value > |
| using | gradient_type = std::remove_cvref_t< Gradient > |
Public Types inherited from MeltPoolDG::CompressibleFlow::DofValueMixin< dim, Value::value_type, DofValueAndGradientStateView< dim, number, Value, Gradient > > | |
| using | Idx = ConservedVariableIndex< dim > |
Public Types inherited from MeltPoolDG::CompressibleFlow::DofGradientMixin< dim, Gradient::value_type::value_type, DofValueAndGradientStateView< dim, number, Value, Gradient > > | |
| using | Idx = ConservedVariableIndex< dim > |
Public Member Functions | |
| DofValueAndGradientStateView (Value &value_state, Gradient &gradient_state, const MaterialPhaseData< number > &material_data) | |
| operator DofValueAndGradientStateView< dim, number, const Value, const Gradient > () | |
| Value & | value () const |
| Gradient & | gradient_value () const |
| EquationOfState | eos_type () const |
| const MaterialPhaseData< number > & | material () const |
Public Member Functions inherited from MeltPoolDG::CompressibleFlow::DofValueMixin< dim, Value::value_type, DofValueAndGradientStateView< dim, number, Value, Gradient > > | |
| 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::DofGradientMixin< dim, Gradient::value_type::value_type, DofValueAndGradientStateView< dim, number, Value, Gradient > > | |
| 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 |
Public Member Functions inherited from MeltPoolDG::Flow::EOSValueMixin< dim, Value::value_type, DofValueAndGradientStateView< dim, number, Value, Gradient > > | |
| 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::Flow::EOSGradientMixin< dim, DofValueAndGradientStateView< dim, number, Value, Gradient > > | |
| decltype(auto) | grad_temperature () const |
Public Member Functions inherited from MeltPoolDG::CompressibleFlow::MaterialMixin< DofValueAndGradientStateView< dim, number, Value, Gradient > > | |
| 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 |
| Gradient * | flow_gradient_state |
| const MaterialPhaseData< number > & | material_data |
Detailed Description
template<int dim, typename number, IsConservedStateCompatible< dim > Value, IsConservedGradientCompatible< dim > Gradient>
struct MeltPoolDG::CompressibleFlow::DofValueAndGradientStateView< dim, number, Value, Gradient >
struct MeltPoolDG::CompressibleFlow::DofValueAndGradientStateView< dim, number, Value, Gradient >
View providing access to the conserved variables and their gradients stored in the underlying data structure.
Besides direct access to the conserved quantities and their gradients, the view enables computation of primitive variables, thermodynamic quantities, and material properties via the provided equation of state and material data. If supported by the equation of state, gradients of primitive variables (e.g., the temperature gradient) can also be derived.
The underlying ValueState and GradientState must store the conserved variables in a tensor-like container indexed according to TensorStorageIndex<dim>.
- Template Parameters
-
ValueState Type of the data structure storing the conserved variables. GradientState Type of the data structure storing the gradients of conserved variables.
Member Typedef Documentation
◆ gradient_type
template<int dim, typename number , IsConservedStateCompatible< dim > Value, IsConservedGradientCompatible< dim > Gradient>
| using MeltPoolDG::CompressibleFlow::DofValueAndGradientStateView< dim, number, Value, Gradient >::gradient_type = std::remove_cvref_t<Gradient> |
◆ state_type
template<int dim, typename number , IsConservedStateCompatible< dim > Value, IsConservedGradientCompatible< dim > Gradient>
| using MeltPoolDG::CompressibleFlow::DofValueAndGradientStateView< dim, number, Value, Gradient >::state_type = std::remove_cvref_t<Value> |
Constructor & Destructor Documentation
◆ DofValueAndGradientStateView()
template<int dim, typename number , IsConservedStateCompatible< dim > Value, IsConservedGradientCompatible< dim > Gradient>
|
inline |
Member Function Documentation
◆ eos_type()
template<int dim, typename number , IsConservedStateCompatible< dim > Value, IsConservedGradientCompatible< dim > Gradient>
|
inline |
◆ gradient_value()
template<int dim, typename number , IsConservedStateCompatible< dim > Value, IsConservedGradientCompatible< dim > Gradient>
|
inline |
◆ material()
template<int dim, typename number , IsConservedStateCompatible< dim > Value, IsConservedGradientCompatible< dim > Gradient>
|
inline |
◆ operator DofValueAndGradientStateView< dim, number, const Value, const Gradient >()
template<int dim, typename number , IsConservedStateCompatible< dim > Value, IsConservedGradientCompatible< dim > Gradient>
|
inline |
◆ value()
template<int dim, typename number , IsConservedStateCompatible< dim > Value, IsConservedGradientCompatible< dim > Gradient>
|
inline |
Member Data Documentation
◆ flow_gradient_state
template<int dim, typename number , IsConservedStateCompatible< dim > Value, IsConservedGradientCompatible< dim > Gradient>
|
mutableprivate |
◆ flow_state
template<int dim, typename number , IsConservedStateCompatible< dim > Value, IsConservedGradientCompatible< dim > Gradient>
|
mutableprivate |
◆ material_data
template<int dim, typename number , IsConservedStateCompatible< dim > Value, IsConservedGradientCompatible< dim > Gradient>
|
private |
The documentation for this struct was generated from the following file:
- include/meltpooldg/compressible_flow/state_views.hpp
Generated by
Public Types inherited from