Lethe Open-Source Library version 1.2.0
Developer Guide
Loading...
Searching...
No Matches
InterfaceTools::IsocontourBoundingValues< dim > Struct Template Reference

#include <interface_tools.h>

Public Member Functions

dealii::Vector< double > initialize_bounding_values ()
std::array< std::string, 2 *dim > initialize_bounding_coordinates_names_array ()

Public Attributes

dealii::Vector< double > bounding_values = initialize_bounding_values()
const std::array< std::string, 2 *dim > bounding_coordinates_names
bool isocontour_exists = false

Detailed Description

template<int dim>
struct InterfaceTools::IsocontourBoundingValues< dim >

Bounding values of an isocontour along each coordinate direction ( \(x\) and \(y\) in 2D; \(x\), \(y\), and \(z\) in 3D). A boolean flag also indicates whether the isocontour is present in the simulated domain or not.

Definition at line 1179 of file interface_tools.h.

Member Function Documentation

◆ initialize_bounding_coordinates_names_array()

template<int dim>
std::array< std::string, 2 *dim > InterfaceTools::IsocontourBoundingValues< dim >::initialize_bounding_coordinates_names_array ( )
inline

Initializes the array of coordinate boundary name strings for the isocontour bounding box.

Returns
Array with name strings for bounding coordinates.
  • In 2D: "x_min", "x_max", "y_min", "y_max"
  • In 3D: "x_min", "x_max", "y_min", "y_max", "z_min", "z_max"

Definition at line 1224 of file interface_tools.h.

◆ initialize_bounding_values()

template<int dim>
dealii::Vector< double > InterfaceTools::IsocontourBoundingValues< dim >::initialize_bounding_values ( )
inline

Initializes the vector used to store the bounding values of isocontours.

Returns
Vector of bounding values initialized with extreme values for lower and upper bounds in each coordinate direction.

Definition at line 1204 of file interface_tools.h.

Member Data Documentation

◆ bounding_coordinates_names

template<int dim>
const std::array<std::string, 2 *dim> InterfaceTools::IsocontourBoundingValues< dim >::bounding_coordinates_names
Initial value:
=
std::array< std::string, 2 *dim > initialize_bounding_coordinates_names_array()
Initializes the array of coordinate boundary name strings for the isocontour bounding box.

Array of bounding coordinates names.

Definition at line 1185 of file interface_tools.h.

◆ bounding_values

template<int dim>
dealii::Vector<double> InterfaceTools::IsocontourBoundingValues< dim >::bounding_values = initialize_bounding_values()

Vector containing the bounding values of an isocontour.

Definition at line 1182 of file interface_tools.h.

◆ isocontour_exists

template<int dim>
bool InterfaceTools::IsocontourBoundingValues< dim >::isocontour_exists = false

Boolean that indicates that at least one cell of the domain contains the interface. This is used to indicate when to write values on the console and in the data table. If false, the bounding values are invalid and not added to the tables nor displayed on console.

Definition at line 1194 of file interface_tools.h.


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