InputDefinedBoundaryCondition< dim, number > Struct Template Reference
|
Developer Documentation
|
#include <case_utils.hpp>
Classes | |
| struct | RampUpParameters |
Public Member Functions | |
| std::shared_ptr< dealii::Function< dim > > | create_boundary_function (const number start_time, const int n_species=1) const |
| void | add_user_boundary_condition_parameters (dealii::ParameterHandler &prm, const std::string &boundary_location) |
Public Attributes | |
| BoundaryConditionType | type = BoundaryConditionType::slip_wall |
| Type of the boundary condition (default: slip wall) | |
| std::string | density |
| Prescribed density at the boundary (used if required by the boundary condition type) | |
| std::string | velocity |
| Prescribed velocity vector at the boundary (used if required by the boundary condition type) | |
| std::string | pressure |
| Prescribed pressure at the boundary (used if required by the boundary condition type) | |
| std::string | energy |
| std::string | species_mass_fractions |
| RampUpParameters | inflow_velocity_ramp_up |
| Velocity ramp-up parameters, only relevant for inflow boundaries. | |
| InputDefinedFreeJetInflow< dim, number > | free_jet_inflow |
Detailed Description
struct MeltPoolDG::CompressibleFlow::InputDefinedBoundaryCondition< dim, number >
Struct for storing boundary condition information for a specific boundary 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 type and values of the boundary conditions at the different boundaries of the domain.
Member Function Documentation
◆ add_user_boundary_condition_parameters()
| void MeltPoolDG::CompressibleFlow::InputDefinedBoundaryCondition< dim, number >::add_user_boundary_condition_parameters | ( | dealii::ParameterHandler & | prm, |
| const std::string & | boundary_location | ||
| ) |
This function reads boundary condition data for a single boundary from the user input file. To do this, one provides the name of the subsection in the input file that describes the boundary condition. The data is stored in the corresponding fields of this struct.
- Parameters
-
prm Parameter handler used to read the input file. boundary_location Name of the subsection containing the boundary data.
◆ create_boundary_function()
| std::shared_ptr< dealii::Function< dim > > MeltPoolDG::CompressibleFlow::InputDefinedBoundaryCondition< dim, number >::create_boundary_function | ( | const number | start_time, |
| const int | n_species = 1 |
||
| ) | const |
Creates a function object representing the boundary condition based on the data stored in this struct. For example, for a fixed-pressure outflow, this returns a dealii::Function representing the pressure field at the boundary.
- Parameters
-
start_time Initial time used to initialize the function.
- Returns
- Shared pointer to a dealii::Function representing the boundary condition.
Member Data Documentation
◆ density
| std::string MeltPoolDG::CompressibleFlow::InputDefinedBoundaryCondition< dim, number >::density |
Prescribed density at the boundary (used if required by the boundary condition type)
◆ energy
| std::string MeltPoolDG::CompressibleFlow::InputDefinedBoundaryCondition< dim, number >::energy |
Prescribed specific inner energy at the boundary (used if required by the boundary condition type). For a subsonic outflow with fixed energy, this corresponds to the Dirichlet value for the conservative variable ρ*E, not just the specific inner energy.
◆ free_jet_inflow
| InputDefinedFreeJetInflow<dim, number> MeltPoolDG::CompressibleFlow::InputDefinedBoundaryCondition< dim, number >::free_jet_inflow |
Free jet inflow parameters, only relevant if the boundary condition type is set to a free jet inflow via the enum combined_inflow_no_slip_wall.
◆ inflow_velocity_ramp_up
| RampUpParameters MeltPoolDG::CompressibleFlow::InputDefinedBoundaryCondition< dim, number >::inflow_velocity_ramp_up |
Velocity ramp-up parameters, only relevant for inflow boundaries.
◆ pressure
| std::string MeltPoolDG::CompressibleFlow::InputDefinedBoundaryCondition< dim, number >::pressure |
Prescribed pressure at the boundary (used if required by the boundary condition type)
◆ species_mass_fractions
| std::string MeltPoolDG::CompressibleFlow::InputDefinedBoundaryCondition< dim, number >::species_mass_fractions |
Prescribed mass fractions of species at the boundary (only used for multi-component flow cases and ignored for single-species flow cases). The mass fractions should be provided as a semicolon-separated list of functions. The number of prescribed species mass fractions should be one less than the total number of species in the simulation, since the mass fraction of the last species can be computed from the fact that the mass fractions sum up to one.
◆ type
| BoundaryConditionType MeltPoolDG::CompressibleFlow::InputDefinedBoundaryCondition< dim, number >::type = BoundaryConditionType::slip_wall |
Type of the boundary condition (default: slip wall)
◆ velocity
| std::string MeltPoolDG::CompressibleFlow::InputDefinedBoundaryCondition< dim, number >::velocity |
Prescribed velocity vector at the boundary (used if required by the boundary condition type)
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