FreeJetVelocityFunction< dim, number > Class Template Reference

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

Enum for the type of velocity profile of a free jet inflow. More...

#include <boundary_condition_functions.hpp>

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

Public Member Functions

 FreeJetVelocityFunction (const number peak_inflow_velocity, const FreeJetProfile free_jet_profile, const dealii::Point< dim, number > free_jet_center, const number free_jet_diameter)
 
number value (const dealii::Point< dim, number > &location, const unsigned int component) const final
 

Private Attributes

const FreeJetProfile free_jet_profile
 The type of velocity profile within the free jet.
 
const dealii::Point< dim, number > free_jet_center
 The center of the circular area where the free jet inflow is applied.
 
const number free_jet_radius
 The radius of the circular area where the free jet inflow is applied.
 
const number peak_inflow_velocity
 The maximum velocity at the center of the free jet.
 

Detailed Description

template<int dim, typename number>
class MeltPoolDG::CompressibleFlow::FreeJetVelocityFunction< dim, number >

Enum for the type of velocity profile of a free jet inflow.

A function class that computes the velocity field for a free jet inflow boundary condition. The velocity is defined to be non-zero only within a circular area (the "jet hole") defined by its center and diameter. The velocity profile is calculated depending on the specified FreeJetProfile. Outside of the jet hole, the velocity is zero.

Constructor & Destructor Documentation

◆ FreeJetVelocityFunction()

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

Constructor, stores the passed arguments internally.

Parameters
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

◆ value()

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

Evaluates the velocity component of the free jet inflow at a given location. The velocity is non-zero only within a circular area defined by free_jet_center and free_jet_radius. The velocity profile within this area is determined by the specified free_jet_profile. Outside of this area, the velocity is zero.

Parameters
locationThe spatial location at which to evaluate the velocity.
componentThe index of the velocity component to evaluate (0 for x-velocity, 1 for y-velocity, etc.).

Member Data Documentation

◆ free_jet_center

template<int dim, typename number >
const dealii::Point<dim, number> MeltPoolDG::CompressibleFlow::FreeJetVelocityFunction< dim, number >::free_jet_center
private

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

◆ free_jet_profile

template<int dim, typename number >
const FreeJetProfile MeltPoolDG::CompressibleFlow::FreeJetVelocityFunction< dim, number >::free_jet_profile
private

The type of velocity profile within the free jet.

◆ free_jet_radius

template<int dim, typename number >
const number MeltPoolDG::CompressibleFlow::FreeJetVelocityFunction< dim, number >::free_jet_radius
private

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

◆ peak_inflow_velocity

template<int dim, typename number >
const number MeltPoolDG::CompressibleFlow::FreeJetVelocityFunction< dim, number >::peak_inflow_velocity
private

The maximum velocity at the center of the free jet.


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