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

#include <analytical_solutions.h>

Public Member Functions

 AnalyticalSolution ()
virtual void declare_parameters (ParameterHandler &prm)
virtual void parse_parameters (ParameterHandler &prm)
bool calculate_error ()
void set_enable (bool is_enable)
std::string get_filename ()

Public Attributes

Parameters::Verbosity verbosity = Parameters::Verbosity::quiet
Functions::ParsedFunction< dim > uvwp
Functions::ParsedFunction< dim > temperature
Functions::ParsedFunction< dim > tracer
Parameters::QMOMFunctions< dim > qmom
Functions::ParsedFunction< dim > phase
Functions::ParsedFunction< dim > cahn_hilliard
Functions::ParsedFunction< dim > electromagnetics

Private Attributes

bool enable = false
std::string filename = "L2Error"

Detailed Description

template<int dim>
class AnalyticalSolutions::AnalyticalSolution< dim >

Implements analytical solutions for the Navier-Stokes equations and the other physics supported by lethe.

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

The analytical solution class provides an all common element required for the calculation of analytical solution for all the physics supported by Lethe.

Definition at line 36 of file analytical_solutions.h.

Constructor & Destructor Documentation

◆ AnalyticalSolution()

template<int dim>
AnalyticalSolutions::AnalyticalSolution< dim >::AnalyticalSolution ( )
inline

Construct a new AnalyticalSolution object.

The constructor automatically sets the number of components of each equation manually since all equations currently supported have a set number of equations.

Definition at line 59 of file analytical_solutions.h.

References cahn_hilliard, electromagnetics, temperature, tracer, and uvwp.

Member Function Documentation

◆ calculate_error()

template<int dim>
bool AnalyticalSolutions::AnalyticalSolution< dim >::calculate_error ( )
inline

Checks if the calculation of the error using the analytical solution is enabled. This option is there to prevent unnecessary calculations when no analytical solutions are required.

Definition at line 94 of file analytical_solutions.h.

References enable.

◆ declare_parameters()

template<int dim>
void AnalyticalSolutions::AnalyticalSolution< dim >::declare_parameters ( ParameterHandler & prm)
virtual

Declare the parameters required by the analytical solution within a parameter file.

Parameters
[in,out]prmThe parameter handler object.

Definition at line 12 of file analytical_solutions.cc.

References cahn_hilliard, declare_enum_entry(), Parameters::QMOMFunctions< dim >::declare_parameters(), Parameters::deprecated_verbosity_names(), electromagnetics, enable, filename, phase, Parameters::quiet_or_verbose(), temperature, tracer, uvwp, and verbosity.

◆ get_filename()

template<int dim>
std::string AnalyticalSolutions::AnalyticalSolution< dim >::get_filename ( )
inline

Get the file name associated with the output of the L2 norm of the error calculated using the analytical solution.

Returns
filename A string that contains the filename used to output the L2 norm of the error.

Definition at line 117 of file analytical_solutions.h.

References filename.

◆ parse_parameters()

template<int dim>
void AnalyticalSolutions::AnalyticalSolution< dim >::parse_parameters ( ParameterHandler & prm)
virtual

Parse the parameters required by the analytical solution within a parameter file.

Parameters
[in]prmThe parameter handler object.

Definition at line 79 of file analytical_solutions.cc.

References cahn_hilliard, Parameters::deprecated_verbosity_names(), electromagnetics, enable, filename, phase, qmom, string_to_enum(), temperature, tracer, uvwp, and verbosity.

◆ set_enable()

template<int dim>
void AnalyticalSolutions::AnalyticalSolution< dim >::set_enable ( bool is_enable)
inline

Enables the usage of the analytical solution.

Definition at line 104 of file analytical_solutions.h.

References enable.

Member Data Documentation

◆ cahn_hilliard

template<int dim>
Functions::ParsedFunction<dim> AnalyticalSolutions::AnalyticalSolution< dim >::cahn_hilliard

ParsedFunction that contains the analytical solution for the phase order and the chemical potential.

Definition at line 160 of file analytical_solutions.h.

◆ electromagnetics

template<int dim>
Functions::ParsedFunction<dim> AnalyticalSolutions::AnalyticalSolution< dim >::electromagnetics

ParsedFunction that contains the analytical solution for the electric and magnetic fields (real and imaginary parts).

Definition at line 166 of file analytical_solutions.h.

◆ enable

template<int dim>
bool AnalyticalSolutions::AnalyticalSolution< dim >::enable = false
private

Establishes if the calculation of the analytical solution is enabled or not

Definition at line 43 of file analytical_solutions.h.

◆ filename

template<int dim>
std::string AnalyticalSolutions::AnalyticalSolution< dim >::filename = "L2Error"
private

Filename used to store the L2 norm of the error

Definition at line 48 of file analytical_solutions.h.

◆ phase

template<int dim>
Functions::ParsedFunction<dim> AnalyticalSolutions::AnalyticalSolution< dim >::phase

ParsedFunction that contains the analytical solution for the phase.

Definition at line 154 of file analytical_solutions.h.

◆ qmom

Functions that contain the analytical solution for the fields of the QMOM physics.

Definition at line 149 of file analytical_solutions.h.

◆ temperature

template<int dim>
Functions::ParsedFunction<dim> AnalyticalSolutions::AnalyticalSolution< dim >::temperature

ParsedFunction that contains the analytical solution for the temperature.

Definition at line 138 of file analytical_solutions.h.

◆ tracer

template<int dim>
Functions::ParsedFunction<dim> AnalyticalSolutions::AnalyticalSolution< dim >::tracer

ParsedFunction that contains the analytical solution for the tracer.

Definition at line 143 of file analytical_solutions.h.

◆ uvwp

template<int dim>
Functions::ParsedFunction<dim> AnalyticalSolutions::AnalyticalSolution< dim >::uvwp

ParsedFunction that contains the analytical solution for the velocity components and the pressure.

Definition at line 133 of file analytical_solutions.h.

◆ verbosity

Controls if the L2 norm of the error is printed to the terminal during the simulation.

Definition at line 127 of file analytical_solutions.h.


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