InputDefinedInitialCondition< dim, number > Struct Template Reference
|
Developer Documentation
|
#include <case_utils.hpp>
Public Member Functions | |
| std::shared_ptr< dealii::Function< dim, number > > | create_initial_condition_function (const number initial_time, const int n_species=1) const |
| void | add_parameters (dealii::ParameterHandler &prm) |
Public Attributes | |
| std::string | density |
| Function describing the initial density field. | |
| std::string | velocity |
| Function describing the initial velocity field. | |
| std::string | inner_energy |
| Function describing the initial specific inner energy. | |
| std::string | species_mass_fractions |
Detailed Description
struct MeltPoolDG::CompressibleFlow::InputDefinedInitialCondition< dim, number >
Struct for storing initial condition information and creating a corresponding function object for use in simulations. This can be used to provide cases where via the input file the user can specify the initial condition of the simulation, e.g., by providing functions for the initial density, velocity, and energy fields. For multi-component flow cases, the user can also provide functions for the initial species mass fraction fields.
Member Function Documentation
◆ add_parameters()
| void MeltPoolDG::CompressibleFlow::InputDefinedInitialCondition< dim, number >::add_parameters | ( | dealii::ParameterHandler & | prm | ) |
Adds all required parameters for the initial condition to the parameter handler.
- Parameters
-
prm Parameter handler to which the parameters will be added.
◆ create_initial_condition_function()
| std::shared_ptr< dealii::Function< dim, number > > MeltPoolDG::CompressibleFlow::InputDefinedInitialCondition< dim, number >::create_initial_condition_function | ( | const number | initial_time, |
| const int | n_species = 1 |
||
| ) | const |
Creates a function object representing the initial condition based on the data stored in this struct.
For multi-component flow cases, this returns a ConservativeVariablesFunction initialized with the provided strings for density, velocity, energy, and species mass fractions. For single-species flow cases, the returned function is initialized with density, velocity, and energy only; species mass fractions are ignored.
- Parameters
-
initial_time Initial time used to initialize the function. n_species Total number of species in the simulation. Determines how many species mass fraction functions are initialized in the returned function. Set to 1 for single-species cases.
Member Data Documentation
◆ density
| std::string MeltPoolDG::CompressibleFlow::InputDefinedInitialCondition< dim, number >::density |
Function describing the initial density field.
◆ inner_energy
| std::string MeltPoolDG::CompressibleFlow::InputDefinedInitialCondition< dim, number >::inner_energy |
Function describing the initial specific inner energy.
◆ species_mass_fractions
| std::string MeltPoolDG::CompressibleFlow::InputDefinedInitialCondition< dim, number >::species_mass_fractions |
Function describing the initial species mass fractions (only used for multi-component flow cases)
◆ velocity
| std::string MeltPoolDG::CompressibleFlow::InputDefinedInitialCondition< dim, number >::velocity |
Function describing the initial velocity field.
The documentation for this struct was generated from the following files:
- include/meltpooldg/compressible_flow/case_utils.hpp
- source/compressible_flow/case_utils.cpp
Generated by