ExternalFlowForce< dim, number, n_species > Struct Template Reference

Developer Documentation: MeltPoolDG::CompressibleFlow::ExternalFlowForce< dim, number, n_species > Struct Template Reference
Developer Documentation
MeltPoolDG::CompressibleFlow::ExternalFlowForce< dim, number, n_species > Struct Template Referenceabstract

An abstract interface for defining external forces acting on the fluid that must be evaluated and incorporated during the cell loop of an explicit time integration scheme. More...

#include <utils.hpp>

Inheritance diagram for MeltPoolDG::CompressibleFlow::ExternalFlowForce< dim, number, n_species >:
[legend]

Public Member Functions

virtual ~ExternalFlowForce ()=default
 
virtual ConservedVariablesType< dim, number, n_species > value (number time_step_size, unsigned int cell_batch_id, const dealii::Point< dim, dealii::VectorizedArray< number > > &points, const ConservedVariablesType< dim, number, n_species > &w)=0
 

Detailed Description

template<int dim, typename number, int n_species = 1>
struct MeltPoolDG::CompressibleFlow::ExternalFlowForce< dim, number, n_species >

An abstract interface for defining external forces acting on the fluid that must be evaluated and incorporated during the cell loop of an explicit time integration scheme.

This struct serves as a base for user-defined external fluid force models. Any derived class must implement the core functions: value(): Invoked at each quadrature point to compute the contribution of the external force.

Constructor & Destructor Documentation

◆ ~ExternalFlowForce()

template<int dim, typename number , int n_species = 1>
virtual MeltPoolDG::CompressibleFlow::ExternalFlowForce< dim, number, n_species >::~ExternalFlowForce ( )
virtualdefault

Member Function Documentation

◆ value()

template<int dim, typename number , int n_species = 1>
virtual ConservedVariablesType< dim, number, n_species > MeltPoolDG::CompressibleFlow::ExternalFlowForce< dim, number, n_species >::value ( number  time_step_size,
unsigned int  cell_batch_id,
const dealii::Point< dim, dealii::VectorizedArray< number > > &  points,
const ConservedVariablesType< dim, number, n_species > &  w 
)
pure virtual

This function computes the value of the external force contribution for the balance of mass, momentum, and energy equations at the given set of points. The returned value then contains the body force as given in the respective governing equations and can directly be added to the right-hand side.

Parameters
time_step_sizeSize of the current time step.
cell_batch_idThe ID of the cell batch for which to compute the external force.
pointsCoordinates of the points at which the external force is evaluated.
wConserved variables at the corresponding points.
Returns
The computed contribution of the external force to be added to the conservation equations.

The documentation for this struct was generated from the following file:
  • include/meltpooldg/compressible_flow/utils.hpp