NLMech  0.1.0
inp::ModelDeck Struct Reference

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

#include <modelDeck.h>

Collaboration diagram for inp::ModelDeck:
Collaboration graph

Public Member Functions

 ModelDeck ()
 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

size_t d_dim
 Dimension.
 
double d_dt
 Size of time steps.
 
double d_h
 Mesh size.
 
double d_horizon
 Horizon.
 
bool d_isRestartActive
 Flag indicating if this restart problem.
 
size_t d_Nt
 Number of time steps.
 
int d_rh
 Ratio of Horizon to mesh size. More...
 
std::string d_simType
 Simulation type. More...
 
std::string d_spatialDiscretization
 Tag for spatial discretization. More...
 
double d_tFinal
 Final simulation time.
 
std::string d_timeDiscretization
 Tag for time discretization. More...
 

Detailed Description

Structure to read and store model related input data.

Member Function Documentation

◆ print()

void inp::ModelDeck::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::ModelDeck::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_rh

int inp::ModelDeck::d_rh

Ratio of Horizon to mesh size.

E.g. ratio = 4 means mesh size is 1/4th of the horizon.

◆ d_simType

std::string inp::ModelDeck::d_simType

Simulation type.

List of allowed values are:

  • explicit
  • implicit

Referenced by printStr().

◆ d_spatialDiscretization

std::string inp::ModelDeck::d_spatialDiscretization

Tag for spatial discretization.

List of allowed values are:

  • finite_difference
  • weak_finite_element
  • nodal_finite_element
  • truss_finite_element

Referenced by printStr().

◆ d_timeDiscretization

std::string inp::ModelDeck::d_timeDiscretization

Tag for time discretization.

List of allowed values are:

  • empty string
  • central_difference
  • velocity_verlet

Referenced by printStr().


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