![]() |
Lethe Open-Source Library version 1.2.0
Developer Guide
|
#include <parameters.h>
Classes | |
| struct | ProbingPointsPerVariable |
Public Member Functions | |
| void | declare_parameters (ParameterHandler &prm) |
| void | parse_parameters (ParameterHandler &prm) |
| void | add_probing_point (const Variable &variable, const unsigned int &id, const Point< dim > &point) |
Public Attributes | |
| unsigned int | number_of_probing_points = 0 |
| unsigned int | max_number_of_probing_points = 25 |
| std::vector< std::string > | probing_points_output_names |
| std::map< Variable, ProbingPointsPerVariable > | probing_points_per_variable |
Probing points parameters. This is used to monitor the evolution of variables (e.g., temperature) at specified points in the domain.
The probing points are grouped according the evaluated variables in the map ProbingPoints::probing_points_per_variable for easier access when postprocessing in the different physics. The names (output filenames) of the probes are stored in the vector ProbingPoints::probing_points_output_names. The indices of the vector correspond to the probe IDs.
Definition at line 1361 of file parameters.h.
|
inline |
Adds an entry to probing_points_per_variable.
| [in] | variable | Variable of the monitored quantity. |
| [in] | id | Identifier of the probe. |
| [in] | point | Location of the probe. |
Definition at line 1421 of file parameters.h.
References get_variable_string(), Parameters::PostProcessing< dim >::ProbingPoints::ProbingPointsPerVariable::ids, Parameters::PostProcessing< dim >::ProbingPoints::ProbingPointsPerVariable::points, and probing_points_per_variable.
| void Parameters::PostProcessing< dim >::ProbingPoints::declare_parameters | ( | ParameterHandler & | prm | ) |
Declare the parameters in the parameter handler.
| [in,out] | prm | The parameter handler. |
Definition at line 2561 of file parameters.cc.
References enum_to_choices(), enum_to_selection(), enum_to_string(), max_number_of_probing_points, number_of_probing_points, and velocity.
| void Parameters::PostProcessing< dim >::ProbingPoints::parse_parameters | ( | ParameterHandler & | prm | ) |
Parse the parameters from the parameter handler.
| [in] | prm | The parameter handler. |
Definition at line 2606 of file parameters.cc.
References add_probing_point(), max_number_of_probing_points, number_of_probing_points, probing_points_output_names, string_to_enum(), and value_string_to_tensor().
| unsigned int Parameters::PostProcessing< dim >::ProbingPoints::max_number_of_probing_points = 25 |
Maximum number of probing points.
Definition at line 1382 of file parameters.h.
| unsigned int Parameters::PostProcessing< dim >::ProbingPoints::number_of_probing_points = 0 |
Number of probing points.
Definition at line 1379 of file parameters.h.
| std::vector<std::string> Parameters::PostProcessing< dim >::ProbingPoints::probing_points_output_names |
Probing point output names ordered by ID.
Definition at line 1385 of file parameters.h.
| std::map<Variable, ProbingPointsPerVariable> Parameters::PostProcessing< dim >::ProbingPoints::probing_points_per_variable |
Map that regroups all probing points information (ID and coordinates) of a same variable under the same variable key. This map is used within the physics to quickly identify the probes that request an evaluation of one of its variables.
Definition at line 1396 of file parameters.h.