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

#include <parameters.h>

Public Types

enum class  PermeabilityModel : std::int8_t { none , darcy_phase_change , carman_kozeny_phase_change }
enum class  RotatingFrameType : std::int8_t { none , srf }

Public Member Functions

void parse_parameters (ParameterHandler &prm)

Static Public Member Functions

static void declare_parameters (ParameterHandler &prm)

Public Attributes

RotatingFrameType rotating_frame_type = RotatingFrameType::none
double omega_x = 0.
double omega_y = 0.
double omega_z = 0.
PermeabilityModel permeability_model = PermeabilityModel::none
FluidIndicator fluid_with_phase_change = FluidIndicator::fluid_0
bool enable_darcy_multiply_by_density = false
std::vector< double > carman_kozeny_permeability_area {1e-3, 1e-3}
std::vector< double > carman_kozeny_tolerance {1e-3, 1e-3}

Detailed Description

VelocitySource - Adds velocity-dependent source term to the Navier-Stokes equations with the appropriate jacobian matrix. Currently only a change to a rotating frame is supported, but additional terms such as a Darcy force or similar could be easily added.

Definition at line 2290 of file parameters.h.

Member Enumeration Documentation

◆ PermeabilityModel

enum class Parameters::VelocitySource::PermeabilityModel : std::int8_t
strong
Enumerator
none 

No Darcy source term.

darcy_phase_change 

Phase change Darcy source term which applies a linear penalization depending on the phase change model

carman_kozeny_phase_change 

Phase change Carman-Kozeny source term which applies a non-linear penalization depending on the phase change model

Definition at line 2292 of file parameters.h.

◆ RotatingFrameType

enum class Parameters::VelocitySource::RotatingFrameType : std::int8_t
strong
Enumerator
none 
srf 

Definition at line 2302 of file parameters.h.

Member Function Documentation

◆ declare_parameters()

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

◆ parse_parameters()

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

Member Data Documentation

◆ carman_kozeny_permeability_area

std::vector<double> Parameters::VelocitySource::carman_kozeny_permeability_area {1e-3, 1e-3}

Permeability area of the pseudo-porous bed (solid phase).

Definition at line 2335 of file parameters.h.

◆ carman_kozeny_tolerance

std::vector<double> Parameters::VelocitySource::carman_kozeny_tolerance {1e-3, 1e-3}

Tolerance in the Carman-Kozeny source term that avoids division by zero.

Definition at line 2338 of file parameters.h.

◆ enable_darcy_multiply_by_density

bool Parameters::VelocitySource::enable_darcy_multiply_by_density = false

Enable the multiplication of the Darcy force term ( \(\vec{F}_\mathrm{Darcy}\)) by the density for dimensional consistency when solving the pressure rather than the kinematic pressure in the momentum balance.

\[\vec{F}_\mathrm{Darcy} = \rho K \vec{u} \]

with \(\rho\) the density, \(K\) the Darcy penalty, and \(\vec{u}\) the velocity.

Definition at line 2332 of file parameters.h.

◆ fluid_with_phase_change

FluidIndicator Parameters::VelocitySource::fluid_with_phase_change = FluidIndicator::fluid_0

Indicates which fluids are with liquid-solid phase change.

Definition at line 2317 of file parameters.h.

◆ omega_x

double Parameters::VelocitySource::omega_x = 0.

Definition at line 2309 of file parameters.h.

◆ omega_y

double Parameters::VelocitySource::omega_y = 0.

Definition at line 2310 of file parameters.h.

◆ omega_z

double Parameters::VelocitySource::omega_z = 0.

Definition at line 2311 of file parameters.h.

◆ permeability_model

PermeabilityModel Parameters::VelocitySource::permeability_model = PermeabilityModel::none

Type of permeability model applied to the Navier-Stokes equations.

Definition at line 2314 of file parameters.h.

◆ rotating_frame_type

RotatingFrameType Parameters::VelocitySource::rotating_frame_type = RotatingFrameType::none

Definition at line 2308 of file parameters.h.


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