NLMech  0.1.0
inp::ICData Struct Reference

Structure to store initial condition input data. More...

#include <initialConditionDeck.h>

Collaboration diagram for inp::ICData:
Collaboration graph

Public Member Functions

 ICData ()=default
 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

std::string d_file
 Filename (if any) to read velocity/displacement.
 
std::vector< double > d_params
 List of parameters.
 
std::string d_type
 Tag specifying the formula to compute initial displacement and velocity. More...
 

Detailed Description

Structure to store initial condition input data.

Member Function Documentation

◆ print()

void inp::ICData::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::ICData::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(), and inp::InitialConditionDeck::printStr().

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

Field Documentation

◆ d_type

std::string inp::ICData::d_type

Tag specifying the formula to compute initial displacement and velocity.

Example:

  • constant – for constant function

Referenced by printStr().


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