MultiSpeciesFluxView< dim, n_species, FluxTypeIn > Struct Template Reference

Developer Documentation: MeltPoolDG::CompressibleFlow::MultiSpeciesFluxView< dim, n_species, FluxTypeIn > Struct Template Reference
Developer Documentation
MeltPoolDG::CompressibleFlow::MultiSpeciesFluxView< dim, n_species, FluxTypeIn > Struct Template Reference

#include <state_views_multi_species.hpp>

Inheritance diagram for MeltPoolDG::CompressibleFlow::MultiSpeciesFluxView< dim, n_species, FluxTypeIn >:
[legend]
Collaboration diagram for MeltPoolDG::CompressibleFlow::MultiSpeciesFluxView< dim, n_species, FluxTypeIn >:
[legend]

Public Types

using FluxType = FluxTypeIn
 
- Public Types inherited from MeltPoolDG::CompressibleFlow::FluxMixin< dim, MultiSpeciesFluxView< dim, n_species, FluxTypeIn > >
using Idx = ConservedVariableIndex< dim >
 

Public Member Functions

 MultiSpeciesFluxView (FluxType &flux_in)
 
 operator MultiSpeciesFluxView< dim, n_species, const FluxType > ()
 
FluxTypevalue () const
 
- Public Member Functions inherited from MeltPoolDG::CompressibleFlow::FluxMixin< dim, MultiSpeciesFluxView< dim, n_species, FluxTypeIn > >
decltype(auto) density_flux () const
 
decltype(auto) momentum_flux (const unsigned int component) const
 
decltype(auto) energy_flux () const
 
- Public Member Functions inherited from MeltPoolDG::SpeciesTransport::FluxMixin< n_conserved_variables< dim >, n_species, MultiSpeciesFluxView< dim, n_species, FluxTypeIn > >
decltype(auto) partial_density_flux (const unsigned species_component) const
 

Private Attributes

FluxTypeflux
 

Detailed Description

template<int dim, int n_species, typename FluxTypeIn>
struct MeltPoolDG::CompressibleFlow::MultiSpeciesFluxView< dim, n_species, FluxTypeIn >

View providing access to the fluxes stored in the underlying data structure. Besides direct access to the fluxes, no further functionality is provided.

The underlying FluxType must store the fluxes in a tensor-like container indexed according to TensorStorageIndex<dim>.

Template Parameters
FluxTypeType of the data structure storing the fluxes.

Member Typedef Documentation

◆ FluxType

template<int dim, int n_species, typename FluxTypeIn >
using MeltPoolDG::CompressibleFlow::MultiSpeciesFluxView< dim, n_species, FluxTypeIn >::FluxType = FluxTypeIn

Constructor & Destructor Documentation

◆ MultiSpeciesFluxView()

template<int dim, int n_species, typename FluxTypeIn >
MeltPoolDG::CompressibleFlow::MultiSpeciesFluxView< dim, n_species, FluxTypeIn >::MultiSpeciesFluxView ( FluxType flux_in)
inlineexplicit

Member Function Documentation

◆ operator MultiSpeciesFluxView< dim, n_species, const FluxType >()

template<int dim, int n_species, typename FluxTypeIn >
MeltPoolDG::CompressibleFlow::MultiSpeciesFluxView< dim, n_species, FluxTypeIn >::operator MultiSpeciesFluxView< dim, n_species, const FluxType > ( )
inline

◆ value()

template<int dim, int n_species, typename FluxTypeIn >
FluxType & MeltPoolDG::CompressibleFlow::MultiSpeciesFluxView< dim, n_species, FluxTypeIn >::value ( ) const
inline

Member Data Documentation

◆ flux

template<int dim, int n_species, typename FluxTypeIn >
FluxType* MeltPoolDG::CompressibleFlow::MultiSpeciesFluxView< dim, n_species, FluxTypeIn >::flux
mutableprivate

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