MultiSpeciesDofStateView< dim, n_species, number, Value > Struct Template Reference
|
Developer Documentation
|
Public Types |
Public Member Functions |
Static Public Attributes |
Private Attributes |
List of all members
MeltPoolDG::CompressibleFlow::MultiSpeciesDofStateView< dim, n_species, number, Value > Struct Template Reference
#include <state_views_multi_species.hpp>
Inheritance diagram for MeltPoolDG::CompressibleFlow::MultiSpeciesDofStateView< dim, n_species, number, Value >:
Collaboration diagram for MeltPoolDG::CompressibleFlow::MultiSpeciesDofStateView< dim, n_species, number, Value >:
Public Types | |
| using | state_type = std::remove_cvref_t< Value > |
Public Types inherited from MeltPoolDG::CompressibleFlow::DofValueMixin< dim, Value::value_type, MultiSpeciesDofStateView< dim, n_species, number, Value > > | |
| using | Idx = ConservedVariableIndex< dim > |
Public Types inherited from MeltPoolDG::SpeciesTransport::DofValueMixin< n_conserved_variables< dim >, n_species, Value, MultiSpeciesDofStateView< dim, n_species, number, Value > > | |
| using | value_type = std::conditional_t< std::is_const_v< std::remove_reference_t< Value > >, std::add_const_t< typename ValueType::value_type >, typename ValueType::value_type > |
Public Types inherited from MeltPoolDG::SpeciesTransport::DerivedPartialValueMixin< n_species, Value, MultiSpeciesDofStateView< dim, n_species, number, Value > > | |
| using | value_type = std::conditional_t< std::is_const_v< std::remove_reference_t< Value > >, std::add_const_t< typename ValueType::value_type >, typename ValueType::value_type > |
Public Member Functions | |
| MultiSpeciesDofStateView (Value &value_state, const MaterialPhaseData< number > &material_data) | |
| operator MultiSpeciesDofStateView< dim, n_species, 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, MultiSpeciesDofStateView< dim, n_species, 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, MultiSpeciesDofStateView< dim, n_species, 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::SpeciesTransport::DofValueMixin< n_conserved_variables< dim >, n_species, Value, MultiSpeciesDofStateView< dim, n_species, number, Value > > | |
| ValueType::value_type | mass_fraction (const unsigned species_component) const |
| value_type & | partial_density (const unsigned species_component) const |
Public Member Functions inherited from MeltPoolDG::CompressibleFlow::MultiSpeciesMaterialMixin< n_species, number, Value::value_type, MultiSpeciesDofStateView< dim, n_species, number, Value > > | |
| Value::value_type | dynamic_viscosity () const |
| number | dynamic_viscosity (const unsigned species_component) const |
| Value::value_type | thermal_conductivity () const |
| number | thermal_conductivity (const unsigned species_component) const |
| Value::value_type | heat_capacity_ratio () const |
| number | heat_capacity_ratio (const unsigned species_component) const |
| Value::value_type | specific_gas_constant () const |
| number | specific_gas_constant (const unsigned species_component) const |
| Value::value_type | specific_isobaric_heat () const |
| number | specific_isobaric_heat (const unsigned species_component) const |
| number | binary_diffusion_coefficient (const unsigned component_i, const unsigned component_j) const |
| Value::value_type | molar_mass () const |
| Value::value_type | molar_mass (const unsigned species_component) const |
Public Member Functions inherited from MeltPoolDG::SpeciesTransport::EffectiveMaterialMixin< n_species, number, ValueType, Derived > | |
| ValueType | mole_fraction (const unsigned species_component) const |
| ValueType | mixture_averaged_diffusion_coefficient (const unsigned int species_component) const |
| template<typename ContainerType , typename SpeciesMaterial > requires requires(int i) { { std::declval<const Derived>().mass_fraction(i) } -> std::convertible_to<ValueType>; } | |
| ValueType | effective_material_property (const ContainerType &species_material, number SpeciesMaterial::*property) const |
Public Member Functions inherited from MeltPoolDG::SpeciesTransport::DerivedPartialValueMixin< n_species, Value, MultiSpeciesDofStateView< dim, n_species, number, Value > > | |
| ValueType::value_type | partial_pressure (const unsigned species_component) const |
| ValueType::value_type | partial_inner_energy (const unsigned species_component) const |
Static Public Attributes | |
| static constexpr std::array< EquationOfState, 1 > | supported_eos = {{EquationOfState::ideal_gas}} |
Private Attributes | |
| Value * | flow_state |
| const MaterialPhaseData< number > & | material_data |
Additional Inherited Members | |
Public Attributes inherited from MeltPoolDG::SpeciesTransport::DofValueMixin< n_conserved_variables< dim >, n_species, Value, MultiSpeciesDofStateView< dim, n_species, number, Value > > | |
| std::optional< typename ValueType::value_type > | mass_fraction |
| std::optional< typename ValueType::value_type > | partial_density |
Detailed Description
template<int dim, int n_species, typename number, IsConservedStateCompatible< dim > Value>
struct MeltPoolDG::CompressibleFlow::MultiSpeciesDofStateView< dim, n_species, number, Value >
struct MeltPoolDG::CompressibleFlow::MultiSpeciesDofStateView< dim, n_species, number, Value >
View providing access to the conserved variables including partial densities 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> and higher indices must represent the partial densities.
- Template Parameters
-
n_species Number of species. StateType Type of the data structure storing the conserved variables.
Member Typedef Documentation
◆ state_type
template<int dim, int n_species, typename number , IsConservedStateCompatible< dim > Value>
| using MeltPoolDG::CompressibleFlow::MultiSpeciesDofStateView< dim, n_species, number, Value >::state_type = std::remove_cvref_t<Value> |
Constructor & Destructor Documentation
◆ MultiSpeciesDofStateView()
template<int dim, int n_species, typename number , IsConservedStateCompatible< dim > Value>
|
inline |
Member Function Documentation
◆ eos_type()
template<int dim, int n_species, typename number , IsConservedStateCompatible< dim > Value>
|
inline |
◆ material()
template<int dim, int n_species, typename number , IsConservedStateCompatible< dim > Value>
|
inline |
◆ operator MultiSpeciesDofStateView< dim, n_species, number, const Value >()
template<int dim, int n_species, typename number , IsConservedStateCompatible< dim > Value>
|
inline |
◆ value()
template<int dim, int n_species, typename number , IsConservedStateCompatible< dim > Value>
|
inline |
Member Data Documentation
◆ flow_state
template<int dim, int n_species, typename number , IsConservedStateCompatible< dim > Value>
|
mutableprivate |
◆ material_data
template<int dim, int n_species, typename number , IsConservedStateCompatible< dim > Value>
|
private |
◆ supported_eos
template<int dim, int n_species, typename number , IsConservedStateCompatible< dim > Value>
|
staticconstexpr |
The documentation for this struct was generated from the following file:
- include/meltpooldg/compressible_flow/state_views_multi_species.hpp
Generated by
Public Types inherited from