Lethe Open-Source Library version 1.2.0
Developer Guide
Loading...
Searching...
No Matches
Parameters::PostProcessing< dim >::ProbingPoints Struct Reference

#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

Detailed Description

template<int dim>
struct Parameters::PostProcessing< dim >::ProbingPoints

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.

Remarks
The points defined must be part of the domain.

Definition at line 1361 of file parameters.h.

Member Function Documentation

◆ add_probing_point()

template<int dim>
void Parameters::PostProcessing< dim >::ProbingPoints::add_probing_point ( const Variable & variable,
const unsigned int & id,
const Point< dim > & point )
inline

Adds an entry to probing_points_per_variable.

Parameters
[in]variableVariable of the monitored quantity.
[in]idIdentifier of the probe.
[in]pointLocation 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.

◆ declare_parameters()

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

Declare the parameters in the parameter handler.

Parameters
[in,out]prmThe 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.

◆ parse_parameters()

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

Parse the parameters from the parameter handler.

Parameters
[in]prmThe 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().

Member Data Documentation

◆ max_number_of_probing_points

template<int dim>
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.

◆ number_of_probing_points

template<int dim>
unsigned int Parameters::PostProcessing< dim >::ProbingPoints::number_of_probing_points = 0

Number of probing points.

Definition at line 1379 of file parameters.h.

◆ probing_points_output_names

template<int dim>
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.

◆ probing_points_per_variable

template<int dim>
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.

Remarks
This is the only place where the probing points are stored. They are directly parsed in this map from the parameter file.

Definition at line 1396 of file parameters.h.


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