Lethe Open-Source Library version 1.2.0
Developer Guide
Loading...
Searching...
No Matches
Parameters::TracerDriftVelocity< dim > Class Template Reference

#include <tracer_drift_velocity.h>

Public Member Functions

 TracerDriftVelocity ()
virtual void declare_parameters (ParameterHandler &prm)
virtual void parse_parameters (ParameterHandler &prm)

Public Attributes

std::shared_ptr< Functions::ParsedFunction< dim > > drift_velocity

Detailed Description

template<int dim>
class Parameters::TracerDriftVelocity< dim >

Implements a drift velocity function to account for simplified multiphase flows.

Template Parameters
dimAn integer that denotes the dimension of the space in which the flow is solved.

The drift velocity provides a simple way to model dilute disperse multiphase flow through the tracer physics.

Definition at line 32 of file tracer_drift_velocity.h.

Constructor & Destructor Documentation

◆ TracerDriftVelocity()

template<int dim>
Parameters::TracerDriftVelocity< dim >::TracerDriftVelocity ( )
inline

Definition at line 35 of file tracer_drift_velocity.h.

References drift_velocity.

Member Function Documentation

◆ declare_parameters()

template<int dim>
void Parameters::TracerDriftVelocity< dim >::declare_parameters ( ParameterHandler & prm)
virtual

Declare the parameters required by the drift velocity.

Parameters
[in,out]prmThe parameter handler object.

Definition at line 65 of file tracer_drift_velocity.h.

References drift_velocity.

◆ parse_parameters()

template<int dim>
void Parameters::TracerDriftVelocity< dim >::parse_parameters ( ParameterHandler & prm)
virtual

Parse the parameters required by the analytical solution within a parameter file.

Parameters
[in]prmThe parameter handler object.

Definition at line 78 of file tracer_drift_velocity.h.

References drift_velocity.

Member Data Documentation

◆ drift_velocity

template<int dim>
std::shared_ptr<Functions::ParsedFunction<dim> > Parameters::TracerDriftVelocity< dim >::drift_velocity

Definition at line 60 of file tracer_drift_velocity.h.


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