libMesh
Public Member Functions | Public Attributes | List of all members
libMesh::EIMVarGroupPlottingInfo Struct Reference

This struct encapsulates data that specifies how we will perform plotting for EIM variable groups. More...

#include <rb_eim_evaluation.h>

Public Member Functions

 EIMVarGroupPlottingInfo ()
 Default constructor. More...
 

Public Attributes

unsigned int first_eim_var_index
 The index for the first EIM variable in this variable group. More...
 
unsigned int n_eim_vars
 The number of EIM variables in the group. More...
 
std::string eim_sys_name
 The name of the System we use for plotting this EIM variable group. More...
 
bool enforce_min_value
 These booleans indicate if we should clamp the resulting output to be above a min value or below a max value. More...
 
bool enforce_max_value
 
Real min_value
 The min (resp. More...
 
Real max_value
 

Detailed Description

This struct encapsulates data that specifies how we will perform plotting for EIM variable groups.

Definition at line 53 of file rb_eim_evaluation.h.

Constructor & Destructor Documentation

◆ EIMVarGroupPlottingInfo()

libMesh::EIMVarGroupPlottingInfo::EIMVarGroupPlottingInfo ( )
inline

Default constructor.

Initialize values that would otherwise be uninitialized. We do not initialize the FEType or string members since they already have default constructors.

Definition at line 61 of file rb_eim_evaluation.h.

62  :
64  n_eim_vars(0),
65  enforce_min_value(false),
66  enforce_max_value(false),
67  min_value(0.),
68  max_value(0.)
69  {
70  }
unsigned int n_eim_vars
The number of EIM variables in the group.
bool enforce_min_value
These booleans indicate if we should clamp the resulting output to be above a min value or below a ma...
unsigned int first_eim_var_index
The index for the first EIM variable in this variable group.

Member Data Documentation

◆ eim_sys_name

std::string libMesh::EIMVarGroupPlottingInfo::eim_sys_name

The name of the System we use for plotting this EIM variable group.

Definition at line 86 of file rb_eim_evaluation.h.

◆ enforce_max_value

bool libMesh::EIMVarGroupPlottingInfo::enforce_max_value

Definition at line 96 of file rb_eim_evaluation.h.

◆ enforce_min_value

bool libMesh::EIMVarGroupPlottingInfo::enforce_min_value

These booleans indicate if we should clamp the resulting output to be above a min value or below a max value.

This can be relevant if we want to satisfy some physical constraints on the outputs, for example, since these constraints may not be exactly satisfied by the EIM output.

Definition at line 95 of file rb_eim_evaluation.h.

◆ first_eim_var_index

unsigned int libMesh::EIMVarGroupPlottingInfo::first_eim_var_index

The index for the first EIM variable in this variable group.

Definition at line 75 of file rb_eim_evaluation.h.

◆ max_value

Real libMesh::EIMVarGroupPlottingInfo::max_value

Definition at line 103 of file rb_eim_evaluation.h.

◆ min_value

Real libMesh::EIMVarGroupPlottingInfo::min_value

The min (resp.

max) value that we enforce if enforce_min_value (resp. enforce_max_value) is true.

Definition at line 102 of file rb_eim_evaluation.h.

◆ n_eim_vars

unsigned int libMesh::EIMVarGroupPlottingInfo::n_eim_vars

The number of EIM variables in the group.

The variables are assumed to be numbered contiguously.

Definition at line 81 of file rb_eim_evaluation.h.


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