MeltPoolDG::SpeciesTransport::MassFractionPostProcessor< dim, n_species, number, View > Class Template Reference

#include <output_post_processor.hpp>

Inheritance diagram for MeltPoolDG::SpeciesTransport::MassFractionPostProcessor< dim, n_species, number, View >:

Collaboration diagram for MeltPoolDG::SpeciesTransport::MassFractionPostProcessor< dim, n_species, number, View >:

Public Member Functions
	MassFractionPostProcessor (const std::function< View(typename View::state_type &)> &view_creator, const std::vector< std::string > &species_names)
std::vector< std::string >	get_names () const override
std::vector< dealii::DataComponentInterpretation::DataComponentInterpretation >	get_data_component_interpretation () const override
dealii::UpdateFlags	get_needed_update_flags () const override
void	evaluate_vector_field (const dealii::DataPostprocessorInputs::Vector< dim > &inputs, std::vector< dealii::Vector< number > > &computed_quantities) const override

Public Attributes
const std::function< View(typename View::state_type &)>	view_creator
std::vector< std::string >	species_names
	Names of the species for output labeling.

Detailed Description

template<int dim, int n_species, typename number, typename View>
requires requires { typename View::state_type; }
class MeltPoolDG::SpeciesTransport::MassFractionPostProcessor< dim, n_species, number, View >

Post-processor for computing species mass fractions. The computation of these variables is defined by the provided view and might involve computations based on the species mass fractions in the solution vector. The post-processor can directly interact with the deal.II data post-processing framework and can be attached to a GenericDataOut object for output generation.

Constructor & Destructor Documentation

MassFractionPostProcessor()

template<int dim, int n_species, typename number , typename View >

MeltPoolDG::SpeciesTransport::MassFractionPostProcessor< dim, n_species, number, View >::MassFractionPostProcessor ( const std::function< View(typename View::state_type &)> &  view_creator, const std::vector< std::string > &  species_names  )

inline

Constructor for the species mass fractions post-processor.

Parameters

view_creator	A function that defines how to construct the view for computing the species mass fractions based on the solution values at a specified node. The function should take a reference to the state type defined by the view and return an instance of the view.
species_names	A vector of strings containing the names of the species for output labeling. The number of names provided should match the number of species in the simulation. The names will be postfixed with " mass fraction" to indicate the nature of the output variable.

Member Function Documentation

evaluate_vector_field()

template<int dim, int n_species, typename number , typename View >

void MeltPoolDG::SpeciesTransport::MassFractionPostProcessor< dim, n_species, number, View >::evaluate_vector_field ( const dealii::DataPostprocessorInputs::Vector< dim > &  inputs, std::vector< dealii::Vector< number > > &  computed_quantities  ) const

inlineoverride

Based on the provided solution values, get the mass fractions and store them in the computed_quantities vector. The mapping from solution values to solution variables is defined by the provided view.

Parameters

inputs	The input data containing solution values at the evaluation points.
computed_quantities	The vector where the computed mass fractions will be stored. Each entry corresponds to an evaluation point and should be filled with the mass fractions variable values in the order defined by get_names().

get_data_component_interpretation()

template<int dim, int n_species, typename number , typename View >

std::vector< dealii::DataComponentInterpretation::DataComponentInterpretation > MeltPoolDG::SpeciesTransport::MassFractionPostProcessor< dim, n_species, number, View >::get_data_component_interpretation ( ) const

inlineoverride

get_names()

template<int dim, int n_species, typename number , typename View >

std::vector< std::string > MeltPoolDG::SpeciesTransport::MassFractionPostProcessor< dim, n_species, number, View >::get_names ( ) const

inlineoverride

get_needed_update_flags()

template<int dim, int n_species, typename number , typename View >

dealii::UpdateFlags MeltPoolDG::SpeciesTransport::MassFractionPostProcessor< dim, n_species, number, View >::get_needed_update_flags ( ) const

inlineoverride

Member Data Documentation

species_names

template<int dim, int n_species, typename number , typename View >

std::vector<std::string> MeltPoolDG::SpeciesTransport::MassFractionPostProcessor< dim, n_species, number, View >::species_names

Names of the species for output labeling.

view_creator

template<int dim, int n_species, typename number , typename View >

const std::function<View(typename View::state_type &)> MeltPoolDG::SpeciesTransport::MassFractionPostProcessor< dim, n_species, number, View >::view_creator

Function defining how to construct the view for computing the mass fractions based on the solution values at a specified node.

---

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

• include/meltpooldg/species_transport/output_post_processor.hpp