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

#include <parameters_multiphysics.h>

Public Member Functions

void parse_parameters (ParameterHandler &prm)
void set_time (const double time)

Static Public Member Functions

static void declare_parameters (ParameterHandler &prm)

Public Attributes

std::shared_ptr< Functions::ParsedFunction< dim > > scalars
QMOMDistributionType distribution_type = QMOMDistributionType::none
std::shared_ptr< Functions::ParsedFunction< dim > > distribution

Detailed Description

template<int dim>
struct Parameters::QMOMFunctions< dim >

Functions of space and time prescribing the fields of the QMOM physics. They are used for the initial conditions, the Dirichlet boundary conditions, the analytical solution and the source terms.

The scalars are given as a list of expressions, one per scalar, in the "scalars" subsection. The moments are not given one by one: they are the raw moments of a particle size distribution, defined in the "distribution" subsection by its family and by a list of expressions whose first entry is the number density, in particles per m^3, followed by the parameters of the family.

The number of scalars is not known when the parameters are declared. The number of components of the scalars function is therefore the number of expressions given, and the QMOM physics verifies that it matches the number of scalars once it is known. The scalars function is ignored if the number of scalars is 0.

Template Parameters
dimNumber of spatial dimensions.

Definition at line 735 of file parameters_multiphysics.h.

Member Function Documentation

◆ declare_parameters()

template<int dim>
void Parameters::QMOMFunctions< dim >::declare_parameters ( ParameterHandler & prm)
static

Declare the "scalars" and "distribution" subsections in the current subsection. All the functions are zero and the distribution type is none by default.

Parameters
[in,out]prmParameter handler.

Definition at line 1190 of file parameters_multiphysics.cc.

References declare_enum_entry(), and Parameters::none.

◆ parse_parameters()

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

Parse the "scalars" and "distribution" subsections of the current subsection. The number of components of each function is the number of expressions separated by semicolons. The number of expressions of the distribution must be one (the number density) plus the number of parameters of its family.

Parameters
[in,out]prmParameter handler.

Definition at line 1215 of file parameters_multiphysics.cc.

References distribution, distribution_type, Parameters::get_number_of_distribution_parameters(), Parameters::none, scalars, and string_to_enum().

◆ set_time()

template<int dim>
void Parameters::QMOMFunctions< dim >::set_time ( const double time)

Set the time of all the functions.

Parameters
[in]timeNew time.

Definition at line 1253 of file parameters_multiphysics.cc.

References distribution, scalars, and Parameters::time.

Member Data Documentation

◆ distribution

template<int dim>
std::shared_ptr<Functions::ParsedFunction<dim> > Parameters::QMOMFunctions< dim >::distribution

Number density, in particles per m^3, followed by the parameters of the particle size distribution. Ignored if the distribution type is none.

Definition at line 746 of file parameters_multiphysics.h.

◆ distribution_type

template<int dim>
QMOMDistributionType Parameters::QMOMFunctions< dim >::distribution_type = QMOMDistributionType::none

Family of the particle size distribution.

Definition at line 741 of file parameters_multiphysics.h.

◆ scalars

template<int dim>
std::shared_ptr<Functions::ParsedFunction<dim> > Parameters::QMOMFunctions< dim >::scalars

Scalars, one component per scalar.

Definition at line 738 of file parameters_multiphysics.h.


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