inp::PBCData Struct Reference

User-input data for particle neighbor search. More...

#include <pBCData.h>

Collaboration diagram for inp::PBCData:

Public Member Functions
	PBCData ()
	Constructor.
std::string	printStr (int nt=0, int lvl=0) const
	Returns the string containing printable information about the object.
void	print (int nt=0, int lvl=0) const
	Prints the information about the object.

Data Fields
std::string	d_selectionType
	Method for applying force e.g.
bool	d_isRegionActive
	Flag that indicates if region-based application of boundary condition is active. So cases of 'region', 'region_with_include_list', 'region_with_exclude_list', and 'region_with_include_list_with_exclude_list' will have region-based application of boundary condition.
util::geometry::GeomData	d_regionGeomData
	Region geometry (if any)
std::vector< size_t >	d_pList
	List of particles (if any)
std::vector< size_t >	d_pNotList
	List of particles to not include (if any)
std::string	d_timeFnType
	Name of the formula with respect to time.
std::string	d_spatialFnType
	Name of the formula of with respect to spatial coordinate.
std::vector< size_t >	d_direction
	List of dofs on which this bc will be applied.
std::vector< double >	d_timeFnParams
	List of parameters for function wrt time.
std::vector< double >	d_spatialFnParams
	List of parameters for function wrt spatial coordinate.
bool	d_isDisplacementZero
	Specify if this bc corresponds to zero displacement condition.

Detailed Description

User-input data for particle neighbor search.

Definition at line 24 of file pBCData.h.

Constructor & Destructor Documentation

PBCData()

inp::PBCData::PBCData ( )

inline

Constructor.

Definition at line 100 of file pBCData.h.

            :
          d_isRegionActive(false), d_regionGeomData(), d_isDisplacementZero(false){};

Member Function Documentation

print()

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

inline

Prints the information about the object.

Parameters

nt	Number of tabs to append before printing
lvl	Information level (higher means more information)

Definition at line 147 of file pBCData.h.

{ std::cout << printStr(nt, lvl); }

References printStr().

Here is the call graph for this function:

printStr()

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

inline

Returns the string containing printable information about the object.

Parameters

nt	Number of tabs to append before printing
lvl	Information level (higher means more information)

Returns

string String containing printable information about the object

Definition at line 110 of file pBCData.h.

                                                    {
 
    auto tabS = util::io::getTabS(nt);
    std::ostringstream oss;
    oss << tabS << "------- PBCData --------" << std::endl << std::endl;
    oss << tabS << "Selection type  = " << d_selectionType << std::endl;
    oss << tabS << "Is region active  = " << d_isRegionActive << std::endl;
    if (d_regionGeomData.d_geom_p != nullptr) {
      oss << tabS << "Region geometry info: " << std::endl;
      oss << d_regionGeomData.printStr(nt+1, lvl);
    }
    if (!d_pList.empty())
      oss << tabS << "Particle list = ["
          << util::io::printStr<size_t>(d_pList, 0) << "]" << std::endl;
    if (!d_pNotList.empty())
      oss << tabS << "Particle excluded list = ["
          << util::io::printStr<size_t>(d_pNotList, 0) << "]" << std::endl;
    oss << tabS << "Time function type = " << d_timeFnType << std::endl;
    oss << tabS << "Time function parameters = ["
        << util::io::printStr<double>(d_timeFnParams, 0) << "]" << std::endl;
    oss << tabS << "Spatial function type = " << d_spatialFnType << std::endl;
    oss << tabS << "Spatial function parameters = ["
        << util::io::printStr<double>(d_spatialFnParams, 0) << "]" << std::endl;
    oss << tabS << "Direction = [" << util::io::printStr<size_t>(d_direction, 0)
        << "]" << std::endl;
    oss << tabS << "Is displacement zero = " << d_isDisplacementZero << std::endl;
    oss << tabS << std::endl;
 
    return oss.str();
  }

References d_direction, util::geometry::GeomData::d_geom_p, d_isDisplacementZero, d_isRegionActive, d_pList, d_pNotList, d_regionGeomData, d_selectionType, d_spatialFnParams, d_spatialFnType, d_timeFnParams, d_timeFnType, util::io::getTabS(), and util::geometry::GeomData::printStr().

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::PBCData::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.

Definition at line 86 of file pBCData.h.

Referenced by printStr().

d_isDisplacementZero

bool inp::PBCData::d_isDisplacementZero

Specify if this bc corresponds to zero displacement condition.

Definition at line 95 of file pBCData.h.

Referenced by printStr().

d_isRegionActive

bool inp::PBCData::d_isRegionActive

Flag that indicates if region-based application of boundary condition is active. So cases of 'region', 'region_with_include_list', 'region_with_exclude_list', and 'region_with_include_list_with_exclude_list' will have region-based application of boundary condition.

Definition at line 42 of file pBCData.h.

Referenced by loading::ParticleFLoading::needToComputeDof(), loading::ParticleULoading::needToComputeDof(), and printStr().

d_pList

std::vector<size_t> inp::PBCData::d_pList

List of particles (if any)

Definition at line 48 of file pBCData.h.

Referenced by loading::ParticleFLoading::needToComputeDof(), loading::ParticleULoading::needToComputeDof(), loading::ParticleFLoading::needToProcessParticle(), loading::ParticleULoading::needToProcessParticle(), and printStr().

d_pNotList

std::vector<size_t> inp::PBCData::d_pNotList

List of particles to not include (if any)

Definition at line 51 of file pBCData.h.

Referenced by loading::ParticleFLoading::needToComputeDof(), loading::ParticleULoading::needToComputeDof(), loading::ParticleFLoading::needToProcessParticle(), loading::ParticleULoading::needToProcessParticle(), and printStr().

d_regionGeomData

util::geometry::GeomData inp::PBCData::d_regionGeomData

Region geometry (if any)

Definition at line 45 of file pBCData.h.

Referenced by loading::ParticleFLoading::needToComputeDof(), loading::ParticleULoading::needToComputeDof(), and printStr().

d_selectionType

std::string inp::PBCData::d_selectionType

Method for applying force e.g.

• particle: provides global id of particle to which force should be applied
• wall: provides global id of wall to which force should be applied
• region: provides area within which all nodes of any particle will get this force

Definition at line 35 of file pBCData.h.

Referenced by loading::ParticleFLoading::needToComputeDof(), loading::ParticleULoading::needToComputeDof(), loading::ParticleFLoading::needToProcessParticle(), loading::ParticleULoading::needToProcessParticle(), and printStr().

d_spatialFnParams

std::vector<double> inp::PBCData::d_spatialFnParams

List of parameters for function wrt spatial coordinate.

Definition at line 92 of file pBCData.h.

Referenced by printStr().

d_spatialFnType

std::string inp::PBCData::d_spatialFnType

Name of the formula of with respect to spatial coordinate.

List of allowed values are:

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

Definition at line 77 of file pBCData.h.

Referenced by printStr().

d_timeFnParams

std::vector<double> inp::PBCData::d_timeFnParams

List of parameters for function wrt time.

Definition at line 89 of file pBCData.h.

Referenced by printStr().

d_timeFnType

std::string inp::PBCData::d_timeFnType

Name of the formula with respect to time.

List of allowed values are:

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

Definition at line 64 of file pBCData.h.

Referenced by printStr().

---

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

• /home/user/project/src/inp/pdecks/pBCData.h