PartialDensityPostProcessor< dim, n_species, number, View > Class Template Reference

Developer Documentation: MeltPoolDG::SpeciesTransport::PartialDensityPostProcessor< dim, n_species, number, View > Class Template Reference
Developer Documentation
MeltPoolDG::SpeciesTransport::PartialDensityPostProcessor< dim, n_species, number, View > Class Template Reference

#include <output_post_processor.hpp>

Inheritance diagram for MeltPoolDG::SpeciesTransport::PartialDensityPostProcessor< dim, n_species, number, View >:
[legend]
Collaboration diagram for MeltPoolDG::SpeciesTransport::PartialDensityPostProcessor< dim, n_species, number, View >:
[legend]

Public Member Functions

 PartialDensityPostProcessor (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::PartialDensityPostProcessor< dim, n_species, number, View >

Post-processor for computing species partial densities. The computation of these variables is defined by the provided view and might involve computations based on the species partial densities 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

◆ PartialDensityPostProcessor()

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

Constructor for the species partial densities post-processor.

Parameters
view_creatorA function that defines how to construct the view for computing the species partial densities 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_namesA 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 " partial density" 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::PartialDensityPostProcessor< 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 partial densities and store them in the computed_quantities vector. The mapping from solution values to solution variables is defined by the provided view.

Parameters
inputsThe input data containing solution values at the evaluation points.
computed_quantitiesThe vector where the computed partial densities will be stored. Each entry corresponds to an evaluation point and should be filled with the partial densities 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::PartialDensityPostProcessor< 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::PartialDensityPostProcessor< 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::PartialDensityPostProcessor< 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::PartialDensityPostProcessor< 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::PartialDensityPostProcessor< dim, n_species, number, View >::view_creator

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


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