FreeJetInflow< dim, number > Class Template Reference

Developer Documentation: MeltPoolDG::CompressibleFlow::FreeJetInflow< dim, number > Class Template Reference
Developer Documentation
MeltPoolDG::CompressibleFlow::FreeJetInflow< dim, number > Class Template Reference

#include <boundary_condition_functions.hpp>

Inheritance diagram for MeltPoolDG::CompressibleFlow::FreeJetInflow< dim, number >:
[legend]
Collaboration diagram for MeltPoolDG::CompressibleFlow::FreeJetInflow< dim, number >:
[legend]

Public Member Functions

 FreeJetInflow (const number initial_time, const number density, const number inner_energy, const number peak_inflow_velocity, const FreeJetProfile free_jet_profile, const dealii::Point< dim, number > free_jet_center, const number free_jet_diameter)
 
 FreeJetInflow (const number initial_time, const number density, const number inner_energy, const std::vector< number > &species_mass_fractions, const number peak_inflow_velocity, const FreeJetProfile free_jet_profile, const dealii::Point< dim, number > free_jet_center, const number free_jet_diameter)
 
void set_velocity_ramp_up (const number duration, const RampUpType type)
 
void set_time (const number new_time) override
 
number value (const dealii::Point< dim, number > &location, const unsigned int component) const final
 

Private Member Functions

bool point_inside_jet_hole (const dealii::Point< dim, number > &location) const
 

Private Attributes

ConservativeVariablesFunction< dim, number > conservative_variables
 The function used to compute the conservative variable values.
 
unsigned n_mass_fractions = 1
 
struct { 
 
   number   jet_hole_radius 
 The radius of the circular area where the free jet inflow is applied. More...
 
   dealii::Point< dim, number >   jet_hole_center 
 The center of the circular area where the free jet inflow is applied. More...
 
free_jet_parameters 
 

Constructor & Destructor Documentation

◆ FreeJetInflow() [1/2]

template<int dim, typename number >
MeltPoolDG::CompressibleFlow::FreeJetInflow< dim, number >::FreeJetInflow ( const number  initial_time,
const number  density,
const number  inner_energy,
const number  peak_inflow_velocity,
const FreeJetProfile  free_jet_profile,
const dealii::Point< dim, number >  free_jet_center,
const number  free_jet_diameter 
)

Constructor for the single species case.

Parameters
initial_timeInitial time used to initialize the function.
densityThe density of the inflow.
inner_energyThe specific inner energy of the inflow.
peak_inflow_velocityThe maximum velocity at the center of the free jet.
free_jet_profileThe type of velocity profile within the free jet.
free_jet_centerThe center of the circular area where the free jet inflow is applied.
free_jet_diameterThe diameter of the circular area where the free jet inflow is applied.

◆ FreeJetInflow() [2/2]

template<int dim, typename number >
MeltPoolDG::CompressibleFlow::FreeJetInflow< dim, number >::FreeJetInflow ( const number  initial_time,
const number  density,
const number  inner_energy,
const std::vector< number > &  species_mass_fractions,
const number  peak_inflow_velocity,
const FreeJetProfile  free_jet_profile,
const dealii::Point< dim, number >  free_jet_center,
const number  free_jet_diameter 
)

Constructor for the multi-species case.

Parameters
initial_timeInitial time used to initialize the function.
densityThe density of the inflow.
inner_energyThe specific inner energy of the inflow.
species_mass_fractionsThe mass fractions of the different species in the inflow.
peak_inflow_velocityThe maximum velocity at the center of the free jet.
free_jet_profileThe type of velocity profile within the free jet.
free_jet_centerThe center of the circular area where the free jet inflow is applied.
free_jet_diameterThe diameter of the circular area where the free jet inflow is applied.

Member Function Documentation

◆ point_inside_jet_hole()

template<int dim, typename number >
bool MeltPoolDG::CompressibleFlow::FreeJetInflow< dim, number >::point_inside_jet_hole ( const dealii::Point< dim, number > &  location) const
private

Checks whether a given point is located within the circular area (the "jet hole") where the free jet inflow is applied.

Parameters
locationThe spatial location to check.
Returns
True if the point is inside the jet hole, false otherwise.

◆ set_time()

template<int dim, typename number >
void MeltPoolDG::CompressibleFlow::FreeJetInflow< dim, number >::set_time ( const number  new_time)
override

Sets the current time for the function.

Parameters
new_timeTime to be set.

◆ set_velocity_ramp_up()

template<int dim, typename number >
void MeltPoolDG::CompressibleFlow::FreeJetInflow< dim, number >::set_velocity_ramp_up ( const number  duration,
const RampUpType  type 
)

Set a velocity ramp-up for the free jet inflow. If this function is never called or if a ramp-up duration of zero is specified, no ramp-up is applied and the returned velocity values correspond directly to the fully developed velocity field.

Parameters
durationThe duration of the ramp-up.
typeThe type of ramp-up function.

◆ value()

template<int dim, typename number >
number MeltPoolDG::CompressibleFlow::FreeJetInflow< dim, number >::value ( const dealii::Point< dim, number > &  location,
const unsigned int  component 
) const
final

Evaluates the conservative variable values for the free jet inflow at a given location. The first component specifies whether the locations is inside (return value of 1.0) or outside (return value of 0.0)the jet.

Parameters
locThe spatial location at which to evaluate the conservative variables.
componentThe index of the component to return. For an interpretation of the component indices, see CombinedInflowNoSlipWallValueInterpretation.

Member Data Documentation

◆ conservative_variables

template<int dim, typename number >
ConservativeVariablesFunction<dim, number> MeltPoolDG::CompressibleFlow::FreeJetInflow< dim, number >::conservative_variables
private

The function used to compute the conservative variable values.

◆ [struct]

struct { ... } MeltPoolDG::CompressibleFlow::FreeJetInflow< dim, number >::free_jet_parameters

◆ jet_hole_center

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

The center of the circular area where the free jet inflow is applied.

◆ jet_hole_radius

template<int dim, typename number >
number MeltPoolDG::CompressibleFlow::FreeJetInflow< dim, number >::jet_hole_radius

The radius of the circular area where the free jet inflow is applied.

◆ n_mass_fractions

template<int dim, typename number >
unsigned MeltPoolDG::CompressibleFlow::FreeJetInflow< dim, number >::n_mass_fractions = 1
private

The total number of mass fractions supported by this function, i.e., as the function provides conservative variables, the total number of partial densities provided.


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