NLMech  0.1.0
inp::BCData Struct Reference

Structure for displacement/force boundary condition input data. More...

#include <loadingDeck.h>

Collaboration diagram for inp::BCData:
Collaboration graph

Public Member Functions

 BCData ()
 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::vector< size_t > d_direction
 List of dofs on which this BC will be applied. More...
 
double d_r1
 Radius (for circle and outer for torus)
 
double d_r2
 Inner radius (for torus)
 
std::string d_regionType
 Type of region over which the bc will be applied. More...
 
std::vector< double > d_spatialFnParams
 List of parameters for function wrt spatial coordinate.
 
std::string d_spatialFnType
 Name of the formula of with respect to spatial coordinate. More...
 
double d_theta
 Angle of the rectangle (for angled rectangle)
 
std::vector< double > d_timeFnParams
 List of parameters for function wrt time.
 
std::string d_timeFnType
 Name of the formula with respect to time. More...
 
double d_x1
 X coordinate of left-bottom point of rectangle/angled rectangle.
 
double d_x2
 X coordinate of right-top point of rectangle/angled rectangle.
 
double d_y1
 Y coordinate of left-bottom point of rectangle/angled rectangle.
 
double d_y2
 Y coordinate of right-top point of rectangle/angled rectangle.
 
double d_z1
 Z coordinate of left-bottom-back point of cuboid.
 
double d_z2
 Z coordinate of right-top-front point of cuboid.
 

Detailed Description

Structure for displacement/force boundary condition input data.

Member Function Documentation

◆ print()

void inp::BCData::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::BCData::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_direction

std::vector<size_t> inp::BCData::d_direction

List of dofs on which this BC will be applied.

E.g. if BC is only applied on x-component, d_direction will be 1. If BC is applied on x- and y-component, d_direction will be vector with elements 1 and 2.

Referenced by loading::FLoading::apply(), loading::ULoading::apply(), printStr(), and inp::Input::setLoadingDeck().

◆ d_regionType

std::string inp::BCData::d_regionType

Type of region over which the bc will be applied.

List of allowed values are:

  • line (1d)
  • rectangle (2d)
  • angled_rectangle (2d)
  • cuboid (3d)
  • displacement_from_pum (2d only)

Referenced by loading::ULoading::apply(), printStr(), and inp::Input::setLoadingDeck().

◆ d_spatialFnType

std::string inp::BCData::d_spatialFnType

Name of the formula of with respect to spatial coordinate.

List of allowed values are:

  • "" (none)
  • constant
  • hat_x
  • hat_y
  • sin

Referenced by loading::FLoading::apply(), loading::ULoading::apply(), printStr(), and inp::Input::setLoadingDeck().

◆ d_timeFnType

std::string inp::BCData::d_timeFnType

Name of the formula with respect to time.

List of allowed values are:

  • "" (none)
  • constant
  • linear
  • linear_step
  • linear_slow_fast

Referenced by loading::FLoading::apply(), loading::ULoading::apply(), printStr(), and inp::Input::setLoadingDeck().


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