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

#include <ale.h>

Public Member Functions

 ALE ()
virtual void declare_parameters (ParameterHandler &prm)
virtual void parse_parameters (ParameterHandler &prm)
bool enabled () const

Public Attributes

std::shared_ptr< Functions::ParsedFunction< dim > > velocity

Private Attributes

bool enable

Detailed Description

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

An interface for all the common parameters required to consider a moving frame of reference in a simplified Arbitrary Lagrangian Eulerian (ALE) module.

Template Parameters
dimAn integer that denotes the dimension of the space in which the problem is solved.

Definition at line 24 of file ale.h.

Constructor & Destructor Documentation

◆ ALE()

template<int dim>
Parameters::ALE< dim >::ALE ( )
inline

Construct a new ALE object.

Definition at line 30 of file ale.h.

References velocity.

Member Function Documentation

◆ declare_parameters()

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

Declare the parameters.

Parameters
[in,out]prmThe ParameterHandler object.

Definition at line 78 of file ale.h.

References velocity.

◆ enabled()

template<int dim>
bool Parameters::ALE< dim >::enabled ( ) const
inline

Return if the ALE module is enabled.

Returns
enable A boolean that indicates if the ALE module is enabled.

Definition at line 64 of file ale.h.

References enable.

◆ parse_parameters()

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

Parse the parameters.

Parameters
[in]prmThe ParameterHandler object.

Definition at line 96 of file ale.h.

References enable, and velocity.

Member Data Documentation

◆ enable

template<int dim>
bool Parameters::ALE< dim >::enable
private

Boolean indicating if the ALE module is enabled.

Definition at line 73 of file ale.h.

◆ velocity

template<int dim>
std::shared_ptr<Functions::ParsedFunction<dim> > Parameters::ALE< dim >::velocity

ALE velocity function.

Definition at line 56 of file ale.h.


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