NLMech  0.1.0
inp::NeighborDeck Struct Reference

Structure to read and store neighbor list related input data. More...

#include <neighborDeck.h>

Collaboration diagram for inp::NeighborDeck:
Collaboration graph

Public Member Functions

 NeighborDeck ()
 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_addPartialElems
 Flag to include partially inside nodes in neighbor list. More...
 
double d_safetyFactor
 Safety factor for neighbor list calculation.
 

Detailed Description

Structure to read and store neighbor list related input data.

Member Function Documentation

◆ print()

void inp::NeighborDeck::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::NeighborDeck::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_addPartialElems

bool inp::NeighborDeck::d_addPartialElems

Flag to include partially inside nodes in neighbor list.

Flag which specifies if the partially inside nodes (elements if the discretization is weak finite element) should be included in the neighbor list

Referenced by printStr().


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