AdvectionDiffusionCaseParameters< number > Struct Template Reference

Developer Documentation: MeltPoolDG::LevelSet::AdvectionDiffusionCaseParameters< number > Struct Template Reference
Developer Documentation
MeltPoolDG::LevelSet::AdvectionDiffusionCaseParameters< number > Struct Template Reference

#include <advection_diffusion_case.hpp>

Inheritance diagram for MeltPoolDG::LevelSet::AdvectionDiffusionCaseParameters< number >:
[legend]
Collaboration diagram for MeltPoolDG::LevelSet::AdvectionDiffusionCaseParameters< number >:
[legend]

Public Attributes

BaseData base
 
TimeIntegration::TimeSteppingData< number > time_stepping
 
AdaptiveMeshingData< number > amr
 
AdvectionDiffusionData< number > advec_diff
 
OutputData< number > output
 
Profiling::ProfilingData< number > profiling
 

Protected Member Functions

void add_parameters (dealii::ParameterHandler &prm) final
 Add parameters to the ParameterHandler.
 
void post (const std::string &parameter_filename) final
 Post-processing after reading the parameter file.
 

Additional Inherited Members

- Public Member Functions inherited from MeltPoolDG::ParametersBase
virtual void process_parameters_file (dealii::ParameterHandler &prm, const std::string &parameter_filename)
 Process a parameter file and populate the ParameterHandler.
 
void print_parameters (dealii::ParameterHandler &prm, std::ostream &pcout, const bool print_details)
 Print parameters to an output stream.
 
- Protected Attributes inherited from MeltPoolDG::ParametersBase
bool parameters_read = false
 

Member Function Documentation

◆ add_parameters()

template<typename number >
void MeltPoolDG::LevelSet::AdvectionDiffusionCaseParameters< number >::add_parameters ( dealii::ParameterHandler &  prm)
inlinefinalprotectedvirtual

Add parameters to the ParameterHandler.

Derived classes must implement this method to define the parameters managed by the ParameterHandler.

Parameters
prmThe ParameterHandler object where parameters will be added.

Implements MeltPoolDG::ParametersBase.

◆ post()

template<typename number >
void MeltPoolDG::LevelSet::AdvectionDiffusionCaseParameters< number >::post ( const std::string &  parameter_filename)
inlinefinalprotectedvirtual

Post-processing after reading the parameter file.

This method is called after the parameter file has been parsed. Derived classes can override it to perform additional setup or validation based on the file contents.

Parameters
parameter_filenameThe name of the parameter file that was processed.

Implements MeltPoolDG::ParametersBase.

Member Data Documentation

◆ advec_diff

template<typename number >
AdvectionDiffusionData<number> MeltPoolDG::LevelSet::AdvectionDiffusionCaseParameters< number >::advec_diff

◆ amr

template<typename number >
AdaptiveMeshingData<number> MeltPoolDG::LevelSet::AdvectionDiffusionCaseParameters< number >::amr

◆ base

template<typename number >
BaseData MeltPoolDG::LevelSet::AdvectionDiffusionCaseParameters< number >::base

◆ output

template<typename number >
OutputData<number> MeltPoolDG::LevelSet::AdvectionDiffusionCaseParameters< number >::output

◆ profiling

template<typename number >
Profiling::ProfilingData<number> MeltPoolDG::LevelSet::AdvectionDiffusionCaseParameters< number >::profiling

◆ time_stepping

template<typename number >
TimeIntegration::TimeSteppingData<number> MeltPoolDG::LevelSet::AdvectionDiffusionCaseParameters< number >::time_stepping

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