Lethe Open-Source Library version 1.2.0
Developer Guide
Loading...
Searching...
No Matches
Parameters Namespace Reference

Namespaces

namespace  Lagrangian

Classes

class  ALE
class  Dimensionality
class  Manifolds
struct  SizeOfSubsections
struct  SimulationControl
struct  PhaseChange
struct  PowerLawParameters
struct  CarreauParameters
struct  NonNewtonian
struct  ImmersedSolidTanhParameters
struct  ImmersedSolidGaussianParameters
struct  IsothermalIdealGasDensityParameters
struct  SurfaceTensionParameters
struct  MobilityCahnHilliardParameters
class  Material
class  MaterialInteractions
class  PhysicalProperties
struct  ConstrainSolidDomain
struct  Stabilization
struct  Timer
struct  Forces
struct  Laser_FreeSurfaceRadiation
class  Laser
class  PostProcessing
struct  FEM
struct  NonLinearSolver
struct  LinearSolver
class  Mesh
struct  MultipleAdaptationParameters
struct  MeshAdaptation
struct  MeshBoxRefinement
struct  Testing
struct  Restart
struct  VelocitySource
class  IBParticles
struct  DynamicFlowControl
struct  Evaporation
struct  Mortar
class  VoidFractionParameters
struct  CFDDEM
struct  CahnHilliard_PhaseFilter
struct  CLS_InterfaceSharpening
struct  CLS_SurfaceTensionForce
struct  CLS_PhaseFilter
struct  CLS_PDEBasedInterfaceReinitialization
struct  CLS_GeometricInterfaceReinitialization
struct  CLS_ReinitializationMethod
struct  CLS
struct  CahnHilliard
struct  QMOMPhaseEvolution
struct  QMOMLipidNanoparticleProduction
struct  QMOMPhysicalConstants
struct  QMOMFunctions
struct  QMOM
struct  TimeHarmonicMaxwell
struct  Multiphysics
struct  PeriodicBoundary
class  NitscheObject
class  Nitsche
class  RigidSolidObject
class  DEMSolidObjects
struct  Ramp_n
struct  Ramp_viscosity
struct  Ramp
class  InitialConditions
class  TracerDriftVelocity

Typedefs

using PeriodicBoundaries

Enumerations

enum class  Verbosity : std::uint8_t { quiet , verbose , extra_verbose }
enum class  FluidIndicator : std::uint8_t { fluid_0 , fluid_1 , both }
enum class  VoidFractionMode { function , pcm , qcm , spm }
enum class  QCMFilterType { spherical , gaussian }
enum class  VoidFractionQuadratureRule { gauss , gauss_lobatto }
enum class  DragModel {
  difelice , rong , dallavalle , kochhill ,
  beetstra , gidaspow
}
enum class  DragCoupling { fully_implicit , semi_implicit , fully_explicit }
enum class  VANSModel { modelA , modelB }
enum class  ReinitializationMethodType : std::int8_t { none , projection_based_sharpening , pde_based , geometric }
enum class  SharpeningType : std::int8_t { constant , adaptive }
enum class  RedistanciationTransformationType : std::int8_t { tanh , piecewise_polynomial }
enum class  FilterType : std::int8_t { none , clip , tanh }
enum class  EpsilonSetMethod : std::int8_t { automatic , manual }
enum class  EpsilonVerbosity : std::int8_t { quiet , verbose }
enum class  WaveguideMode : std::int8_t { TE , TM }
enum class  ElectromagneticScalingType : std::int8_t { none , electric_field , magnetic_field , power }
enum class  TimeHarmonicMaxwellCouplingStrategy : std::int8_t { none , iteration , time , threshold }
enum class  QMOMSplittingScheme : std::int8_t { lie , strang }
enum class  QMOMProcess : std::int8_t { generic , lipid_nanoparticle_production }
enum class  QMOMDistributionType : std::int8_t {
  none , normal , lognormal , gamma ,
  weibull , beta , chi , chi_squared
}
enum class  SolidObjectThermalBoundaryType { adiabatic , isothermal }
enum class  FluidDynamicsInitialConditionType {
  L2projection , viscous , nodal , ramp ,
  average_velocity_profile
}
enum class  CLSInitialConditionType { none , diffusive , geometric }

Functions

SizeOfSubsections get_size_of_subsections (const std::string &file_name, const bool require_subsection_size=true)
const DeprecatedEnumNames< Verbosity > & deprecated_verbosity_names ()
const std::vector< Verbosity > & quiet_or_verbose ()
const DeprecatedEnumNames< FluidIndicator > & deprecated_fluid_indicator_names ()
const std::vector< FluidIndicator > & single_fluid_indicators ()
unsigned int get_number_of_distribution_parameters (const QMOMDistributionType distribution_type)

Detailed Description

Drift velocity that is added to the tracer velocity to account for simplified multiphase simulations using drift-flux modeling.

Typedef Documentation

◆ PeriodicBoundaries

Initial value:
std::map<dealii::types::boundary_id, PeriodicBoundary>

The periodic boundary pairs of a simulation, keyed by the principal (first) boundary id of each pair.

CFD and DEM simulations declare their boundary conditions through different parameter classes (BoundaryConditions::BoundaryConditions<BoundaryType> and Parameters::Lagrangian::BCDEM respectively), but both describe periodicity with this container, so that a single routine, setup_periodic_boundary_conditions(), sets up the periodicity of the triangulation for either solver.

Definition at line 36 of file periodic_boundary.h.

Enumeration Type Documentation

◆ CLSInitialConditionType

Enumerator
none 
diffusive 
geometric 

Definition at line 28 of file initial_conditions.h.

◆ DragCoupling

enum class Parameters::DragCoupling
strong

Defines the numerical coupling strategy used for drag force computation between fluid and particles.

This enumeration specifies how the drag interaction term is treated in time integration schemes for coupled CFD-DEM or multiphase simulations. The choice of coupling affects both stability and computational cost. The fully_implicit and fully_explicit schemes are named this way since explicit is a reserved keyword in C++. Thus, we use fully_implicit and fully_explicit to ensure a coherent terminology.

  • fully_implicit: The drag force is evaluated using the current (implicit) fluid velocities and previous (explicit) particle velocity. The resulting drag is applied to both the particles and the fluid. Provides maximum stability, but requires more Newton iterations.
  • semi_implicit: The drag force on the particles is computed using the previous velocities of both the particles and the fluid. When transferring momentum to the fluid, the previous fluid velocity is used to evaluate the momentum transfer coefficient, while the current fluid velocity is used to calculate relative velocity between the particle and the fluid. This provides extensive stability, but for larger time step may lead to a slight violation of Newton's third law since the drag applied on the fluid is not strictly equal to the drag applied to the particles.
  • fully_explicit: The drag is evaluated entirely using known quantities from the previous time step. The outcome conditionally stable and may require very small coupling time step when the density of the fluid is much lower than the density of the particles
Enumerator
fully_implicit 

Fully implicit drag coupling.

semi_implicit 

Semi-implicit drag coupling.

fully_explicit 

Explicit drag coupling.

Definition at line 127 of file parameters_cfd_dem.h.

◆ DragModel

enum class Parameters::DragModel
strong

Drag force model for particle-fluid interaction in CFD-DEM.

Enumerator
difelice 

Di Felice.

rong 

Rong.

dallavalle 

Dallavalle - Valid only for dilute flows.

kochhill 

Koch-Hill.

beetstra 

Beetstra.

gidaspow 

Gidaspow.

Definition at line 76 of file parameters_cfd_dem.h.

◆ ElectromagneticScalingType

enum class Parameters::ElectromagneticScalingType : std::int8_t
strong

Type of electromagnetic scaling to apply to the solution of the time-harmonic Maxwell solver after solving the linear system. This is relevant when the user wants to recover the physical solution in dimensional units from the dimensionless solution.

  • none: no scaling will be applied to the solution after solving the linear system, so the solution will be in dimensionless units.
  • electric_field: the solution will be scaled by the electric scaling factor given from the user input parameter. This factor needs to match the dimensionality of the problem.
  • magnetic_field: the solution will be scaled by the magnetic scaling factor given from the user input parameter. This factor needs to match the dimensionality of the problem.
  • power: the solution will be scaled by the power given from the user input parameter in waveguide inlets. This option is only relevant when there is at least one waveguide inlet in the problem. Note that it is the user's responsibility to ensure that if the problem also applies non-zero electric or magnetic field Dirichlet boundary conditions, those need to be scaled accordingly.
Enumerator
none 
electric_field 
magnetic_field 
power 

Definition at line 142 of file parameters_multiphysics.h.

◆ EpsilonSetMethod

enum class Parameters::EpsilonSetMethod : std::int8_t
strong
Enumerator
automatic 
manual 

Definition at line 92 of file parameters_multiphysics.h.

◆ EpsilonVerbosity

enum class Parameters::EpsilonVerbosity : std::int8_t
strong

Verbosity options for the epsilon parameter.

Enumerator
quiet 

Epsilon related information will not be displayed on terminal.

verbose 

Epsilon value will be displayed on terminal for every steady and transient iteration.

Definition at line 101 of file parameters_multiphysics.h.

◆ FilterType

enum class Parameters::FilterType : std::int8_t
strong

Different phase indicator filtering types:

  • none: no filter wil be applied on the calculated phase indicator
  • tanh: the tanh filter function will be applied to the phase indicator, a \(\beta\) parameter influencing the interface definition must be defined
Enumerator
none 
clip 
tanh 

Definition at line 85 of file parameters_multiphysics.h.

◆ FluidDynamicsInitialConditionType

Enumerator
L2projection 
viscous 
nodal 
ramp 
average_velocity_profile 

Definition at line 18 of file initial_conditions.h.

◆ FluidIndicator

enum class Parameters::FluidIndicator : std::uint8_t
strong

Class to account for different fluid indicators. This is used for multiphase simulations in PostProcessing, in CLS (see parameter_multiphysics.h), and in VelocitySource (phase change Carman-Kozeny permeability model).

Enumerator
fluid_0 

fluid 0 only

fluid_1 

fluid 1 only

both 

both fluids

Definition at line 74 of file parameters.h.

◆ QCMFilterType

enum class Parameters::QCMFilterType
strong

Filter kernel used by the Quadrature-Centered Method (QCM) to weigh particle contributions onto the mesh.

The characteristic length of the filter is taken from VoidFractionParameters::qcm_smoothing_length and VoidFractionParameters::qcm_sphere_equal_cell_volume, with the interpretation depending on the filter:

  • spherical: half of qcm_smoothing_length is the averaging-sphere radius.
  • gaussian: half of qcm_smoothing_length is the Gaussian standard deviation sigma. Note that the Gaussian has non-compact support; sigma should be small relative to the QCM neighbor-cell stencil reach to avoid silent truncation bias.
Enumerator
spherical 

Spherical indicator (heaviside) filter (default, original QCM).

gaussian 

Gaussian filter parametrised by a standard deviation sigma.

Definition at line 54 of file parameters_cfd_dem.h.

◆ QMOMDistributionType

enum class Parameters::QMOMDistributionType : std::int8_t
strong

Family of the particle size distribution from which the moments of the QMOM physics are computed. The raw moments of each family are computed analytically by QMOMKit:

  • none: no particles, all the moments are zero;
  • normal: mean and standard deviation;
  • lognormal: mean and standard deviation of the logarithm of the size;
  • gamma: shape and scale;
  • weibull: shape and scale;
  • beta: shape parameters alpha and beta, on the interval [0, 1];
  • chi: number of degrees of freedom;
  • chi_squared: number of degrees of freedom.
Enumerator
none 
normal 
lognormal 
gamma 
weibull 
beta 
chi 
chi_squared 

Definition at line 690 of file parameters_multiphysics.h.

◆ QMOMProcess

enum class Parameters::QMOMProcess : std::int8_t
strong

Process simulated with the QMOM physics. A process other than generic imposes the scalars and the number of moments.

Enumerator
generic 
lipid_nanoparticle_production 

Definition at line 573 of file parameters_multiphysics.h.

◆ QMOMSplittingScheme

enum class Parameters::QMOMSplittingScheme : std::int8_t
strong

Operator splitting scheme between the physical-space transport (T) and the phase-space evolution (P) of the QMOM fields:

  • lie: T then P over the whole time step (first order);
  • strang: P over half a time step, T, then P over half a time step (second order).
Enumerator
lie 
strang 

Definition at line 563 of file parameters_multiphysics.h.

◆ RedistanciationTransformationType

enum class Parameters::RedistanciationTransformationType : std::int8_t
strong

Different transformation function types for the signed distance:

  • tanh: hyperbolic tangent
  • piecewise_polynomial: 4th degree piecewise polynomial. The latter takes the following form:

    if \(d < 0 \) \(\phi = 0.5 - 0.5(4d' + 6d'^2 + 4*d'^3 + d'^4)\)

    else \(\phi = 0.5 - 0.5(4d' - 6d'^2 + 4*d'^3 - d'^4)\)

    with \(d' = d/d_\mathrm{max}\), where \(\phi\) is the phase fraction, \(d\) the signed distance and \(d_\mathrm{max}\) the maximum redistanciation distance. This transformation clamps the phase fraction to 0 or 1 when \(d = \pm d_\mathrm{max}\).

Enumerator
tanh 
piecewise_polynomial 

Definition at line 72 of file parameters_multiphysics.h.

◆ ReinitializationMethodType

enum class Parameters::ReinitializationMethodType : std::int8_t
strong

Different interface reinitialization method types:

  • none
  • projection_based_sharpening: projection-based interface sharpening
  • pde_based: PDE-based reinitialization
  • geometric: geometric redistanciation
Enumerator
none 
projection_based_sharpening 
pde_based 
geometric 

Definition at line 34 of file parameters_multiphysics.h.

◆ SharpeningType

enum class Parameters::SharpeningType : std::int8_t
strong

Different projection-based interface sharpening types:

  • constant: the sharpening threshold is the same throughout the simulation,
  • adaptive: the sharpening threshold is determined by binary search, to ensure mass conservation of the monitored phase
Enumerator
constant 
adaptive 

Definition at line 49 of file parameters_multiphysics.h.

◆ SolidObjectThermalBoundaryType

Thermal boundary condition type applied on a solid object surface.

Enumerator
adiabatic 

No heat flux through the solid boundary.

isothermal 

Fixed temperature imposed on the solid boundary.

Definition at line 35 of file solid_objects_parameters.h.

◆ TimeHarmonicMaxwellCouplingStrategy

enum class Parameters::TimeHarmonicMaxwellCouplingStrategy : std::int8_t
strong

Parameters for the time coupling strategy of the time-harmonic Maxwell solver with the other physics solvers.

  • none: the time-harmonic Maxwell solver will only be solved at the first iteration of the time integration and will not be solved in the subsequent iterations.
  • iteration: the time-harmonic Maxwell solver will be solved every N time iterations, where N is given by the user input parameter "coupling iteration".
  • time: the time-harmonic Maxwell solver will be solved when crossing a time multiple, e.g. every T seconds, where the time multiple is given by the user input parameter "coupling time".
  • threshold: the time-harmonic Maxwell solver will be solved when the maximum change in the material properties of the problem change beyond a certain threshold, where the threshold value is given by the user input parameter "coupling threshold".
Enumerator
none 
iteration 
time 
threshold 

Definition at line 166 of file parameters_multiphysics.h.

◆ VANSModel

enum class Parameters::VANSModel
strong

Volume-Averaged Navier-Stokes (VANS) model formulation.

Enumerator
modelA 

Model A: volume-averaged continuity and momentum equations.

modelB 

Model B: alternative VANS formulation.

Definition at line 141 of file parameters_cfd_dem.h.

◆ Verbosity

enum class Parameters::Verbosity : std::uint8_t
strong
Enumerator
quiet 
verbose 
extra_verbose 

Definition at line 61 of file parameters.h.

◆ VoidFractionMode

enum class Parameters::VoidFractionMode
strong

Method used to compute the void fraction field.

Enumerator
function 

Void fraction prescribed by an analytical function.

pcm 

Particle centered method.

qcm 

Quadrature centered method.

spm 

Satellite point method (divided approach).

Definition at line 28 of file parameters_cfd_dem.h.

◆ VoidFractionQuadratureRule

Quadrature rule used for void fraction integration.

Enumerator
gauss 

Gauss quadrature rule (default).

gauss_lobatto 

Gauss-Lobatto quadrature rule.

Definition at line 65 of file parameters_cfd_dem.h.

◆ WaveguideMode

enum class Parameters::WaveguideMode : std::int8_t
strong

Types of waveguide port modes:

  • Transverse Electric (TE): the electric field is transverse to the direction of propagation.
  • Transverse Magnetic (TM): the magnetic field is transverse to the direction of propagation.
Enumerator
TE 

Transverse Electric mode.

TM 

Transverse Magnetic mode.

Definition at line 117 of file parameters_multiphysics.h.

Function Documentation

◆ deprecated_fluid_indicator_names()

const DeprecatedEnumNames< FluidIndicator > & Parameters::deprecated_fluid_indicator_names ( )

Return the deprecated strings of the parameters parsed into a FluidIndicator, which remain accepted in parameter files.

Returns
The deprecated strings, each paired with its FluidIndicator.

Definition at line 118 of file parameters.cc.

References fluid_0, and fluid_1.

◆ deprecated_verbosity_names()

const DeprecatedEnumNames< Verbosity > & Parameters::deprecated_verbosity_names ( )

Return the deprecated strings of the parameters parsed into a Verbosity, which remain accepted in parameter files.

Returns
The deprecated strings, each paired with its Verbosity.

Definition at line 102 of file parameters.cc.

References extra_verbose.

◆ get_number_of_distribution_parameters()

unsigned int Parameters::get_number_of_distribution_parameters ( const QMOMDistributionType distribution_type)

Number of parameters of a particle size distribution family, not counting the number density.

Parameters
[in]distribution_typeFamily of the distribution.
Returns
Number of parameters of the family.

Definition at line 1167 of file parameters_multiphysics.cc.

References beta, chi, chi_squared, gamma, lognormal, none, normal, and weibull.

◆ get_size_of_subsections()

SizeOfSubsections Parameters::get_size_of_subsections ( const std::string & file_name,
const bool require_subsection_size = true )

Extract the maximum number of all variable size sections within the parameter file.

Parameters
[in]file_nameName of the parameter file from which the sizes are parsed
[in]require_subsection_sizeIf true, the parameter file must indicate the size of at least one variable size subsection, which is the case for every solver for which a "boundary conditions" subsection is mandatory. The DEM solvers, whose boundary conditions are declared in a "DEM boundary conditions" subsection with a "number of boundary conditions" entry, set this to false and consequently obtain a size of zero for parameter files that do not declare any manifold.

//TODO make the size of the DEM boundary conditions parsed instead.

Returns
The size of the variable size subsections of the parameter file.

Definition at line 135 of file parameters.cc.

References Parameters::SizeOfSubsections::boundary_conditions, get_max_subsection_size(), and Parameters::SizeOfSubsections::manifolds.

◆ quiet_or_verbose()

const std::vector< Verbosity > & Parameters::quiet_or_verbose ( )

Return the verbosity levels accepted by the parameters which do not support Verbosity::extra_verbose.

Returns
Verbosity::quiet and Verbosity::verbose.

Definition at line 110 of file parameters.cc.

References quiet, and verbose.

◆ single_fluid_indicators()

const std::vector< FluidIndicator > & Parameters::single_fluid_indicators ( )

Return the fluid indicators accepted by the parameters which designate a single fluid.

Returns
FluidIndicator::fluid_0 and FluidIndicator::fluid_1.

Definition at line 127 of file parameters.cc.

References fluid_0, and fluid_1.