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

#include <parameters.h>

Public Member Functions

void declare_parameters (ParameterHandler &prm, const unsigned int max_number_of_constraints)
void parse_parameters (ParameterHandler &prm)
void parse_constraint_parameters (const ParameterHandler &prm, const unsigned int constraint_id)

Static Public Member Functions

static void declare_default_entries (ParameterHandler &prm)

Public Attributes

bool enable = false
unsigned int number_of_constraints = 0
std::vector< unsigned int > fluid_ids
std::vector< double > filtered_phase_indicator_tolerance
std::vector< double > temperature_min_values
std::vector< double > temperature_max_values
bool enable_domain_restriction_with_plane = false
Point< dim > restriction_plane_point
Tensor< 1, dim > restriction_plane_normal_vector

Detailed Description

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

Set of parameters constraining a certain portion of a fluid domain to null velocity and pressure fields to mimic a solid subdomain.

Remarks
Pressure DOFs in "solid" cells that are next to "fluid" cells are not constrained.
Template Parameters
dimNumber of dimensions of the problem (2D or 3D).
Note
At the moment, only the temperature field is used to constrain the "solid" domain.

Definition at line 910 of file parameters.h.

Member Function Documentation

◆ declare_default_entries()

template<int dim>
void Parameters::ConstrainSolidDomain< dim >::declare_default_entries ( ParameterHandler & prm)
static

Declare the default parameters for each constraint.

Parameters
[in,out]prmParameterHandler object.

Definition at line 860 of file parameters.cc.

◆ declare_parameters()

template<int dim>
void Parameters::ConstrainSolidDomain< dim >::declare_parameters ( ParameterHandler & prm,
const unsigned int max_number_of_constraints )

Declare the parameters.

Parameters
[in,out]prmParameterHandler object.
[in]max_number_of_constraintsMaximum number of zero velocity constraints applied to the domain.

Definition at line 799 of file parameters.cc.

References declare_default_entries(), enable, enable_domain_restriction_with_plane, filtered_phase_indicator_tolerance, fluid_ids, number_of_constraints, restriction_plane_normal_vector, restriction_plane_point, temperature_max_values, and temperature_min_values.

◆ parse_constraint_parameters()

template<int dim>
void Parameters::ConstrainSolidDomain< dim >::parse_constraint_parameters ( const ParameterHandler & prm,
const unsigned int constraint_id )

Parse parameters for each constraint.

Parameters
[in]prmParameterHandler object.
[in]constraint_idIdentifiers of the constraint (1 per fluid). The numbering starts at 0.

Definition at line 924 of file parameters.cc.

References filtered_phase_indicator_tolerance, fluid_ids, temperature_max_values, and temperature_min_values.

◆ parse_parameters()

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

Member Data Documentation

◆ enable

template<int dim>
bool Parameters::ConstrainSolidDomain< dim >::enable = false

Enable/disable (true/false) the solid domain constraining feature.

Definition at line 913 of file parameters.h.

◆ enable_domain_restriction_with_plane

template<int dim>
bool Parameters::ConstrainSolidDomain< dim >::enable_domain_restriction_with_plane = false

Enable/disable (true/false) the definition of a plane for geometrical restrictions on the domain where the stasis constraint is applied.

Definition at line 933 of file parameters.h.

◆ filtered_phase_indicator_tolerance

template<int dim>
std::vector<double> Parameters::ConstrainSolidDomain< dim >::filtered_phase_indicator_tolerance

Absolute tolerance applied on filtered phase indicator for constrained cell selection

Definition at line 923 of file parameters.h.

◆ fluid_ids

template<int dim>
std::vector<unsigned int> Parameters::ConstrainSolidDomain< dim >::fluid_ids

Identifiers of fluids that are constrained.

Definition at line 919 of file parameters.h.

◆ number_of_constraints

template<int dim>
unsigned int Parameters::ConstrainSolidDomain< dim >::number_of_constraints = 0

Total number of constraints (maximum of 1 per fluid).

Definition at line 916 of file parameters.h.

◆ restriction_plane_normal_vector

template<int dim>
Tensor<1, dim> Parameters::ConstrainSolidDomain< dim >::restriction_plane_normal_vector

Outward-pointing normal vector from the restricted domain to define the restriction plane for the stasis constraint application domain

Definition at line 941 of file parameters.h.

◆ restriction_plane_point

template<int dim>
Point<dim> Parameters::ConstrainSolidDomain< dim >::restriction_plane_point

Coordinates of a point on the restriction plane for the stasis constraint application domain

Definition at line 937 of file parameters.h.

◆ temperature_max_values

template<int dim>
std::vector<double> Parameters::ConstrainSolidDomain< dim >::temperature_max_values

Upper threshold values of the constraining field (temperature).

Definition at line 929 of file parameters.h.

◆ temperature_min_values

template<int dim>
std::vector<double> Parameters::ConstrainSolidDomain< dim >::temperature_min_values

Lower threshold values of the constraining field (temperature).

Definition at line 926 of file parameters.h.


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