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

#include <dimensionality.h>

Public Member Functions

 Dimensionality ()
void define_all_scales ()
void parse_parameters (ParameterHandler &prm)

Static Public Member Functions

static void declare_parameters (ParameterHandler &prm)

Public Attributes

double length
double mass
double time
double temperature
double electric_current
double density_scaling
double specific_gas_constant_scaling
double viscosity_scaling
double specific_heat_scaling
double thermal_conductivity_scaling
double enthalpy_scaling
double diffusivity_scaling
double thermal_expansion_scaling
double surface_tension_scaling
double surface_tension_gradient_scaling
double cahn_hilliard_mobility_scaling
double cahn_hilliard_epsilon_scaling
double electromagnetic_frequency_scaling
double electric_amplitude_scaling
double magnetic_amplitude_scaling
double vacuum_permittivity_scaling
double vacuum_permeability_scaling

Detailed Description

Class used to rescale physical properties for cases where the main dimensions of the problems (Length, Mass, Time and Temperature) are not expressed in SI, but are expressed in another set of units. For example, this can be used to carry out a simulation where the mesh is expressed in millimeters instead of meters. This class is currently only used to rescale the physical properties in the FEM-based physics (e.g. all of those that are solvers). Support for DEM, CFD-DEM and rescaling of boundary conditions is planned in the midterm.

Definition at line 23 of file dimensionality.h.

Constructor & Destructor Documentation

◆ Dimensionality()

Parameters::Dimensionality::Dimensionality ( )
inline

Default constructor that assumes that the units used in the simulation are consistent.

Definition at line 31 of file dimensionality.h.

References define_all_scales(), electric_current, length, mass, temperature, and time.

Member Function Documentation

◆ declare_parameters()

void Parameters::Dimensionality::declare_parameters ( ParameterHandler & prm)
static

Declare the fundamental dimensions of the parameter file.

Parameters
[in,out]prmThe parameter handler object

Definition at line 45 of file dimensionality.cc.

◆ define_all_scales()

void Parameters::Dimensionality::define_all_scales ( )

Defines all the sub-scales that are relevant to simulations. This is used to define scaling laws for kinematic viscosity or other quantities which appear multiple times in the simulation. This prevents the recalculation of these scales (and thus, human errors).

Definition at line 10 of file dimensionality.cc.

References cahn_hilliard_epsilon_scaling, cahn_hilliard_mobility_scaling, density_scaling, diffusivity_scaling, electric_amplitude_scaling, electric_current, electromagnetic_frequency_scaling, enthalpy_scaling, length, magnetic_amplitude_scaling, mass, specific_gas_constant_scaling, specific_heat_scaling, surface_tension_gradient_scaling, surface_tension_scaling, temperature, thermal_conductivity_scaling, thermal_expansion_scaling, time, vacuum_permeability_scaling, vacuum_permittivity_scaling, and viscosity_scaling.

◆ parse_parameters()

void Parameters::Dimensionality::parse_parameters ( ParameterHandler & prm)

Parses the fundamental dimensions from the parameter file.

Parameters
[in]prmThe parameter handler object

Definition at line 89 of file dimensionality.cc.

References define_all_scales(), electric_current, length, mass, temperature, and time.

Member Data Documentation

◆ cahn_hilliard_epsilon_scaling

double Parameters::Dimensionality::cahn_hilliard_epsilon_scaling

Definition at line 97 of file dimensionality.h.

◆ cahn_hilliard_mobility_scaling

double Parameters::Dimensionality::cahn_hilliard_mobility_scaling

Definition at line 96 of file dimensionality.h.

◆ density_scaling

double Parameters::Dimensionality::density_scaling

Definition at line 86 of file dimensionality.h.

◆ diffusivity_scaling

double Parameters::Dimensionality::diffusivity_scaling

Definition at line 92 of file dimensionality.h.

◆ electric_amplitude_scaling

double Parameters::Dimensionality::electric_amplitude_scaling

Definition at line 99 of file dimensionality.h.

◆ electric_current

double Parameters::Dimensionality::electric_current

Definition at line 77 of file dimensionality.h.

◆ electromagnetic_frequency_scaling

double Parameters::Dimensionality::electromagnetic_frequency_scaling

Definition at line 98 of file dimensionality.h.

◆ enthalpy_scaling

double Parameters::Dimensionality::enthalpy_scaling

Definition at line 91 of file dimensionality.h.

◆ length

double Parameters::Dimensionality::length

Definition at line 73 of file dimensionality.h.

◆ magnetic_amplitude_scaling

double Parameters::Dimensionality::magnetic_amplitude_scaling

Definition at line 100 of file dimensionality.h.

◆ mass

double Parameters::Dimensionality::mass

Definition at line 74 of file dimensionality.h.

◆ specific_gas_constant_scaling

double Parameters::Dimensionality::specific_gas_constant_scaling

Definition at line 87 of file dimensionality.h.

◆ specific_heat_scaling

double Parameters::Dimensionality::specific_heat_scaling

Definition at line 89 of file dimensionality.h.

◆ surface_tension_gradient_scaling

double Parameters::Dimensionality::surface_tension_gradient_scaling

Definition at line 95 of file dimensionality.h.

◆ surface_tension_scaling

double Parameters::Dimensionality::surface_tension_scaling

Definition at line 94 of file dimensionality.h.

◆ temperature

double Parameters::Dimensionality::temperature

Definition at line 76 of file dimensionality.h.

◆ thermal_conductivity_scaling

double Parameters::Dimensionality::thermal_conductivity_scaling

Definition at line 90 of file dimensionality.h.

◆ thermal_expansion_scaling

double Parameters::Dimensionality::thermal_expansion_scaling

Definition at line 93 of file dimensionality.h.

◆ time

double Parameters::Dimensionality::time

Definition at line 75 of file dimensionality.h.

◆ vacuum_permeability_scaling

double Parameters::Dimensionality::vacuum_permeability_scaling

Definition at line 102 of file dimensionality.h.

◆ vacuum_permittivity_scaling

double Parameters::Dimensionality::vacuum_permittivity_scaling

Definition at line 101 of file dimensionality.h.

◆ viscosity_scaling

double Parameters::Dimensionality::viscosity_scaling

Definition at line 88 of file dimensionality.h.


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