NLMech  0.1.0
Public Member Functions | Data Fields
inp::PolicyDeck Struct Reference
Input

Structure to read and store policy related input data. More...

#include <policyDeck.h>

Collaboration diagram for inp::PolicyDeck:
Collaboration graph

Public Member Functions

 PolicyDeck ()
 Constructor.
 
void print (int nt=0, int lvl=0) const
 Prints the information about the instance of the object. More...
 
std::string printStr (int nt=0, int lvl=0) const
 Returns the string containing information about the instance of the object. More...
 

Data Fields

bool d_enablePostProcessing
 Enable post-processing calculation. More...
 
int d_memControlFlag
 Flag which indicates level of memory control to be enforced. More...
 

Detailed Description

Structure to read and store policy related input data.

Member Function Documentation

◆ print()

void inp::PolicyDeck::print ( int  nt = 0,
int  lvl = 0 
) const
inline

Prints the information about the instance of the object.

Parameters
ntNumber of tabs to append before each line of string
lvlLevel of information sought (higher level means more information)
Here is the call graph for this function:

◆ printStr()

std::string inp::PolicyDeck::printStr ( int  nt = 0,
int  lvl = 0 
) const
inline

Returns the string containing information about the instance of the object.

Parameters
ntNumber of tabs to append before each line of string
lvlLevel of information sought (higher level means more information)
Returns
string String containing information about this object

Referenced by print().

Here is the call graph for this function:
Here is the caller graph for this function:

Field Documentation

◆ d_enablePostProcessing

bool inp::PolicyDeck::d_enablePostProcessing

Enable post-processing calculation.

Default is true.

Referenced by model::Output::Output(), inp::Policy::Policy(), and printStr().

◆ d_memControlFlag

int inp::PolicyDeck::d_memControlFlag

Flag which indicates level of memory control to be enforced.

Default is 0 which means no control. Max at present is 2 which means as much control as possible.

Referenced by inp::Policy::Policy(), and printStr().

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