InputDefinedFreeJetInflow< dim, number > Struct Template Reference

Developer Documentation: MeltPoolDG::CompressibleFlow::InputDefinedFreeJetInflow< dim, number > Struct Template Reference
Developer Documentation
MeltPoolDG::CompressibleFlow::InputDefinedFreeJetInflow< dim, number > Struct Template Reference

#include <case_utils.hpp>

Public Member Functions

std::shared_ptr< dealii::Function< dim, number > > create_free_jet_inflow_boundary (const number start_time, const number velocity_ramp_up_duration, const RampUpType velocity_ramp_up_type, const unsigned n_species=1) const
 
void add_parameters (dealii::ParameterHandler &prm)
 

Public Attributes

number jet_hole_diameter {0.}
 Jet-hole diameter.
 
number jet_hole_density {0.}
 Jet-hole density at the inflow boundary.
 
number jet_hole_inner_energy {0.}
 Jet-hole specific inner energy at the inflow boundary.
 
std::vector< number > jet_hole_mass_fractions
 
dealii::Point< dim, number > jet_hole_center
 Jet-hole center coordinates.
 
number jet_peak_velocity {0.}
 Flow jet peak velocity.
 
FreeJetProfile free_jet_profile {FreeJetProfile::constant}
 The velocity profile of the free jet.
 

Detailed Description

template<int dim, typename number>
struct MeltPoolDG::CompressibleFlow::InputDefinedFreeJetInflow< dim, number >

Struct for storing free jet inflow boundary 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 is allowed to specify a free jet inflow boundary condition with user-defined parameters for the free jet inflow.

Member Function Documentation

◆ add_parameters()

template<int dim, typename number >
void MeltPoolDG::CompressibleFlow::InputDefinedFreeJetInflow< dim, number >::add_parameters ( dealii::ParameterHandler &  prm)

Adds the parameters for the free jet inflow to a given ParameterHandler object.

Parameters
prmThe ParameterHandler object to which the parameters should be added.

◆ create_free_jet_inflow_boundary()

template<int dim, typename number >
std::shared_ptr< dealii::Function< dim, number > > MeltPoolDG::CompressibleFlow::InputDefinedFreeJetInflow< dim, number >::create_free_jet_inflow_boundary ( const number  start_time,
const number  velocity_ramp_up_duration,
const RampUpType  velocity_ramp_up_type,
const unsigned  n_species = 1 
) const

Creates a FreeJetInflow function object based on the stored parameters for the free jet inflow which can be used to apply the free jet inflow boundary condition in simulations.

Parameters
start_timeThe initial time at which the free jet inflow boundary condition is applied.
velocity_ramp_up_durationThe duration over which the velocity ramps up.
velocity_ramp_up_typeThe type of ramp up for the velocity.
n_speciesThe total number of species in the simulation.

Member Data Documentation

◆ free_jet_profile

template<int dim, typename number >
FreeJetProfile MeltPoolDG::CompressibleFlow::InputDefinedFreeJetInflow< dim, number >::free_jet_profile {FreeJetProfile::constant}

The velocity profile of the free jet.

◆ jet_hole_center

template<int dim, typename number >
dealii::Point<dim, number> MeltPoolDG::CompressibleFlow::InputDefinedFreeJetInflow< dim, number >::jet_hole_center

Jet-hole center coordinates.

◆ jet_hole_density

template<int dim, typename number >
number MeltPoolDG::CompressibleFlow::InputDefinedFreeJetInflow< dim, number >::jet_hole_density {0.}

Jet-hole density at the inflow boundary.

◆ jet_hole_diameter

template<int dim, typename number >
number MeltPoolDG::CompressibleFlow::InputDefinedFreeJetInflow< dim, number >::jet_hole_diameter {0.}

Jet-hole diameter.

◆ jet_hole_inner_energy

template<int dim, typename number >
number MeltPoolDG::CompressibleFlow::InputDefinedFreeJetInflow< dim, number >::jet_hole_inner_energy {0.}

Jet-hole specific inner energy at the inflow boundary.

◆ jet_hole_mass_fractions

template<int dim, typename number >
std::vector<number> MeltPoolDG::CompressibleFlow::InputDefinedFreeJetInflow< dim, number >::jet_hole_mass_fractions

Jet-hole mass fractions at the inflow boundary (only relevant for multi-component flow cases)

◆ jet_peak_velocity

template<int dim, typename number >
number MeltPoolDG::CompressibleFlow::InputDefinedFreeJetInflow< dim, number >::jet_peak_velocity {0.}

Flow jet peak velocity.


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