![]() |
Lethe Open-Source Library version 1.2.0
Developer Guide
|
#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" |
Implements analytical solutions for the Navier-Stokes equations and the other physics supported by lethe.
| dim | An 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.
|
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.
|
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.
|
virtual |
Declare the parameters required by the analytical solution within a parameter file.
| [in,out] | prm | The 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.
|
inline |
Get the file name associated with the output of the L2 norm of the error calculated using the analytical solution.
Definition at line 117 of file analytical_solutions.h.
References filename.
|
virtual |
Parse the parameters required by the analytical solution within a parameter file.
| [in] | prm | The 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.
|
inline |
Enables the usage of the analytical solution.
Definition at line 104 of file analytical_solutions.h.
References enable.
| 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.
| 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.
|
private |
Establishes if the calculation of the analytical solution is enabled or not
Definition at line 43 of file analytical_solutions.h.
|
private |
Filename used to store the L2 norm of the error
Definition at line 48 of file analytical_solutions.h.
| 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.
| Parameters::QMOMFunctions<dim> AnalyticalSolutions::AnalyticalSolution< dim >::qmom |
Functions that contain the analytical solution for the fields of the QMOM physics.
Definition at line 149 of file analytical_solutions.h.
| 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.
| 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.
| 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.
| Parameters::Verbosity AnalyticalSolutions::AnalyticalSolution< dim >::verbosity = Parameters::Verbosity::quiet |
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.