MultiSpeciesDofValueView< dim, n_species, StateType > Struct Template Reference

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

Developer Documentation

#include <state_views_multi_species.hpp>

Inheritance diagram for MeltPoolDG::CompressibleFlow::MultiSpeciesDofValueView< dim, n_species, StateType >:

[legend]

Collaboration diagram for MeltPoolDG::CompressibleFlow::MultiSpeciesDofValueView< dim, n_species, StateType >:

[legend]

Public Types
using	state_type = std::remove_cvref_t< StateType >

Public Types inherited from MeltPoolDG::CompressibleFlow::DofValueMixin< dim, StateType::value_type, MultiSpeciesDofValueView< dim, n_species, StateType > >
using	Idx = ConservedVariableIndex< dim >

Public Types inherited from MeltPoolDG::SpeciesTransport::DofValueMixin< n_conserved_variables< dim >, n_species, StateType, MultiSpeciesDofValueView< dim, n_species, StateType > >
using	value_type = std::conditional_t< std::is_const_v< std::remove_reference_t< StateType > >, std::add_const_t< typename ValueType::value_type >, typename ValueType::value_type >

Public Member Functions
	MultiSpeciesDofValueView (StateType &state)

	operator MultiSpeciesDofValueView< dim, n_species, const StateType > ()

StateType &	value () const

Public Member Functions inherited from MeltPoolDG::CompressibleFlow::DofValueMixin< dim, StateType::value_type, MultiSpeciesDofValueView< dim, n_species, 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

Public Member Functions inherited from MeltPoolDG::SpeciesTransport::DofValueMixin< n_conserved_variables< dim >, n_species, StateType, MultiSpeciesDofValueView< dim, n_species, StateType > >
ValueType::value_type	mass_fraction (const unsigned species_component) const

value_type &	partial_density (const unsigned species_component) const

Private Attributes
StateType *	flow_state

Additional Inherited Members
Public Attributes inherited from MeltPoolDG::SpeciesTransport::DofValueMixin< n_conserved_variables< dim >, n_species, StateType, MultiSpeciesDofValueView< dim, n_species, StateType > >
std::optional< typename ValueType::value_type >	mass_fraction

std::optional< typename ValueType::value_type >	partial_density

Detailed Description

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

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 directly derived quantities (e.g., velocity or mass fraction) via the corresponding mixin.

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.