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

#include <parameters_lagrangian.h>

Public Member Functions

void parse_parameters (ParameterHandler &prm)

Static Public Member Functions

static void declare_parameters (ParameterHandler &prm)

Public Attributes

bool calculate_force_torque = false
Parameters::Verbosity force_torque_verbosity
unsigned int output_frequency = 1
std::string force_torque_output_name = "force"
Point< 3 > point_center_mass

Detailed Description

template<int dim>
class Parameters::Lagrangian::ForceTorqueOnWall< dim >

ForceTorqueOnWall - Defines the parameters for the force and torques calculation on boundaries of the domain.

Definition at line 688 of file parameters_lagrangian.h.

Member Function Documentation

◆ declare_parameters()

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

Declare the parameters in the parameter handler.

Parameters
[in,out]prmThe parameter handler object.

Definition at line 1258 of file parameters_lagrangian.cc.

References calculate_force_torque, declare_enum_entry(), Parameters::deprecated_verbosity_names(), force_torque_output_name, force_torque_verbosity, output_frequency, point_center_mass, and Parameters::quiet_or_verbose().

◆ parse_parameters()

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

Parse the parameters from the parameter handler.

Parameters
[in]prmThe parameter handler object.

Definition at line 1306 of file parameters_lagrangian.cc.

References calculate_force_torque, Parameters::deprecated_verbosity_names(), force_torque_output_name, force_torque_verbosity, output_frequency, point_center_mass, and string_to_enum().

Member Data Documentation

◆ calculate_force_torque

template<int dim>
bool Parameters::Lagrangian::ForceTorqueOnWall< dim >::calculate_force_torque = false

Enable force and torque post-processing on wall boundaries.

Definition at line 692 of file parameters_lagrangian.h.

◆ force_torque_output_name

template<int dim>
std::string Parameters::Lagrangian::ForceTorqueOnWall< dim >::force_torque_output_name = "force"

File name prefix for force and torque output.

Definition at line 702 of file parameters_lagrangian.h.

◆ force_torque_verbosity

template<int dim>
Parameters::Verbosity Parameters::Lagrangian::ForceTorqueOnWall< dim >::force_torque_verbosity
Initial value:

Verbosity level for force and torque output.

Definition at line 695 of file parameters_lagrangian.h.

◆ output_frequency

template<int dim>
unsigned int Parameters::Lagrangian::ForceTorqueOnWall< dim >::output_frequency = 1

Output frequency (in time steps).

Definition at line 699 of file parameters_lagrangian.h.

◆ point_center_mass

template<int dim>
Point<3> Parameters::Lagrangian::ForceTorqueOnWall< dim >::point_center_mass

Center of mass used for torque computation.

Definition at line 705 of file parameters_lagrangian.h.


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