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

#include <solid_objects_parameters.h>

Public Member Functions

 Nitsche ()=default
void declare_parameters (ParameterHandler &prm)
void parse_parameters (ParameterHandler &prm)

Public Attributes

Verbosity verbosity
std::vector< std::shared_ptr< NitscheObject< dim > > > nitsche_solids
unsigned int number_solids

Static Public Attributes

static const unsigned int max_nitsche_solids = 10

Detailed Description

template<int dim>
class Parameters::Nitsche< dim >

Container class managing multiple Nitsche solid objects.

This class holds a collection of NitscheObject instances and provides parameter declaration and parsing for the Nitsche immersed boundary method section of the parameter file.

Template Parameters
dimNumber of spatial dimensions.

Definition at line 268 of file solid_objects_parameters.h.

Constructor & Destructor Documentation

◆ Nitsche()

template<int dim>
Parameters::Nitsche< dim >::Nitsche ( )
default

Member Function Documentation

◆ declare_parameters()

template<int dim>
void Parameters::Nitsche< dim >::declare_parameters ( ParameterHandler & prm)

Declare the parameters in the parameter handler.

Parameters
[in,out]prmThe parameter handler object.

Definition at line 304 of file solid_objects_parameters.h.

References declare_enum_entry(), Parameters::deprecated_verbosity_names(), max_nitsche_solids, nitsche_solids, Parameters::quiet, and Parameters::quiet_or_verbose().

◆ parse_parameters()

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

Parse the parameters from the parameter handler.

Parameters
[in]prmThe parameter handler object.

Definition at line 334 of file solid_objects_parameters.h.

References Parameters::deprecated_verbosity_names(), nitsche_solids, number_solids, parse_parameters(), string_to_enum(), and verbosity.

Member Data Documentation

◆ max_nitsche_solids

template<int dim>
const unsigned int Parameters::Nitsche< dim >::max_nitsche_solids = 10
static

Maximum number of Nitsche solid objects allowed.

Definition at line 299 of file solid_objects_parameters.h.

◆ nitsche_solids

template<int dim>
std::vector<std::shared_ptr<NitscheObject<dim> > > Parameters::Nitsche< dim >::nitsche_solids

Collection of Nitsche solid objects.

Definition at line 293 of file solid_objects_parameters.h.

◆ number_solids

template<int dim>
unsigned int Parameters::Nitsche< dim >::number_solids

Number of active Nitsche solid objects.

Definition at line 296 of file solid_objects_parameters.h.

◆ verbosity

template<int dim>
Verbosity Parameters::Nitsche< dim >::verbosity

Verbosity level for force/torque output.

Definition at line 290 of file solid_objects_parameters.h.


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