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

#include <solid_objects_parameters.h>

Public Member Functions

 NitscheObject ()
void declare_parameters (ParameterHandler &prm, unsigned int id)
void parse_parameters (ParameterHandler &prm, unsigned int id)

Public Attributes

Parameters::Mesh< dim, spacedim > solid_mesh
unsigned int number_quadrature_points
Functions::ParsedFunction< spacedim > solid_velocity
Functions::ParsedFunction< spacedim > solid_temperature
bool enable_particles_motion
bool enable_heat_bc
double beta
double beta_heat
unsigned int particles_sub_iterations
bool stop_particles_lost
Point< spacedim > center_of_rotation
bool calculate_force_on_solid
bool calculate_torque_on_solid
std::string force_output_name
std::string torque_output_name

Detailed Description

template<int dim, int spacedim = dim>
class Parameters::NitscheObject< dim, spacedim >

Parameters for a single solid object used with the Nitsche immersed boundary method.

This class stores all the parameters needed to define and control an individual Nitsche solid, including its mesh, velocity, temperature, penalization coefficients, particle motion settings, and force/torque calculation options.

Template Parameters
dimNumber of spatial dimensions.

Definition at line 55 of file solid_objects_parameters.h.

Constructor & Destructor Documentation

◆ NitscheObject()

template<int dim, int spacedim = dim>
Parameters::NitscheObject< dim, spacedim >::NitscheObject ( )
inline

Definition at line 58 of file solid_objects_parameters.h.

References solid_velocity.

Member Function Documentation

◆ declare_parameters()

template<int dim, int spacedim>
void Parameters::NitscheObject< dim, spacedim >::declare_parameters ( ParameterHandler & prm,
unsigned int id )

Declare the parameters in the parameter handler.

Parameters
[in,out]prmThe parameter handler object.
[in]idIndex of the solid object.

Definition at line 128 of file solid_objects_parameters.h.

References solid_mesh, solid_temperature, and solid_velocity.

◆ parse_parameters()

template<int dim, int spacedim>
void Parameters::NitscheObject< dim, spacedim >::parse_parameters ( ParameterHandler & prm,
unsigned int id )

Member Data Documentation

◆ beta

template<int dim, int spacedim = dim>
double Parameters::NitscheObject< dim, spacedim >::beta

Penalization parameter for the Nitsche method (momentum equation).

Definition at line 99 of file solid_objects_parameters.h.

◆ beta_heat

template<int dim, int spacedim = dim>
double Parameters::NitscheObject< dim, spacedim >::beta_heat

Penalization parameter for the Nitsche method (heat equation).

Definition at line 102 of file solid_objects_parameters.h.

◆ calculate_force_on_solid

template<int dim, int spacedim = dim>
bool Parameters::NitscheObject< dim, spacedim >::calculate_force_on_solid

Enable calculation of forces on the solid.

Definition at line 114 of file solid_objects_parameters.h.

◆ calculate_torque_on_solid

template<int dim, int spacedim = dim>
bool Parameters::NitscheObject< dim, spacedim >::calculate_torque_on_solid

Enable calculation of torques on the solid.

Definition at line 117 of file solid_objects_parameters.h.

◆ center_of_rotation

template<int dim, int spacedim = dim>
Point<spacedim> Parameters::NitscheObject< dim, spacedim >::center_of_rotation

Center of rotation used for torque calculation.

Definition at line 111 of file solid_objects_parameters.h.

◆ enable_heat_bc

template<int dim, int spacedim = dim>
bool Parameters::NitscheObject< dim, spacedim >::enable_heat_bc

Enable heat boundary condition on the immersed boundary.

Definition at line 96 of file solid_objects_parameters.h.

◆ enable_particles_motion

template<int dim, int spacedim = dim>
bool Parameters::NitscheObject< dim, spacedim >::enable_particles_motion

Enable the motion of Nitsche particles.

Definition at line 93 of file solid_objects_parameters.h.

◆ force_output_name

template<int dim, int spacedim = dim>
std::string Parameters::NitscheObject< dim, spacedim >::force_output_name

File name prefix for the force output.

Definition at line 120 of file solid_objects_parameters.h.

◆ number_quadrature_points

template<int dim, int spacedim = dim>
unsigned int Parameters::NitscheObject< dim, spacedim >::number_quadrature_points

Number of quadrature points per 1D cell used to represent the solid.

Definition at line 84 of file solid_objects_parameters.h.

◆ particles_sub_iterations

template<int dim, int spacedim = dim>
unsigned int Parameters::NitscheObject< dim, spacedim >::particles_sub_iterations

Number of sub-iterations for particle motion integration.

Definition at line 105 of file solid_objects_parameters.h.

◆ solid_mesh

template<int dim, int spacedim = dim>
Parameters::Mesh<dim, spacedim> Parameters::NitscheObject< dim, spacedim >::solid_mesh

Mesh parameters for the solid object.

Definition at line 81 of file solid_objects_parameters.h.

◆ solid_temperature

template<int dim, int spacedim = dim>
Functions::ParsedFunction<spacedim> Parameters::NitscheObject< dim, spacedim >::solid_temperature

Temperature function imposed on the solid boundary.

Definition at line 90 of file solid_objects_parameters.h.

◆ solid_velocity

template<int dim, int spacedim = dim>
Functions::ParsedFunction<spacedim> Parameters::NitscheObject< dim, spacedim >::solid_velocity

Velocity function imposed on the solid.

Definition at line 87 of file solid_objects_parameters.h.

◆ stop_particles_lost

template<int dim, int spacedim = dim>
bool Parameters::NitscheObject< dim, spacedim >::stop_particles_lost

Stop the simulation if Nitsche particles are lost.

Definition at line 108 of file solid_objects_parameters.h.

◆ torque_output_name

template<int dim, int spacedim = dim>
std::string Parameters::NitscheObject< dim, spacedim >::torque_output_name

File name prefix for the torque output.

Definition at line 123 of file solid_objects_parameters.h.


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