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

#include <bcBaseDeck.h>

Collaboration diagram for inp::BCBaseDeck:

Public Member Functions
	BCBaseDeck (const json &j=json({}), std::string type="Force_BC")
	Constructor.

	BCBaseDeck (bool isRegionActive, geom::GeomData regionGeomData=geom::GeomData(), std::vector< size_t > pList=std::vector< size_t >(), std::vector< size_t > pNotList=std::vector< size_t >(), std::string timeFnType="", std::vector< double > timeFnParams=std::vector< double >(), std::string spatialFnType="", std::vector< double > spatialFnParams=std::vector< double >(), std::vector< size_t > direction=std::vector< size_t >(), bool isDisplacementZero=false)
	Constructor.

void	readFromJson (const json &j, std::string type)
	Reads from json object.

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.

Static Public Member Functions
static json	getExampleJson (std::string type="Foce_BC", bool isRegionActive=false, geom::GeomData regionGeomData=geom::GeomData(), std::vector< size_t > pList=std::vector< size_t >(), std::vector< size_t > pNotList=std::vector< size_t >(), std::string timeFnType="", std::vector< double > timeFnParams=std::vector< double >(), std::string spatialFnType="", std::vector< double > spatialFnParams=std::vector< double >(), std::vector< size_t > direction=std::vector< size_t >(), bool isDisplacementZero=false, std::string icType="", std::vector< double > icVec=std::vector< double >())
	Returns example JSON object for ModelDeck configuration.

Data Fields
std::string	d_type
	Method for applying force. E.g., Force_BC, Displacement_BC, IC.

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.

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

std::string	d_icType
	Type.

util::Point	d_icVec
	Initial velocity vector.

Detailed Description

User-input data for particle neighbor search.

Definition at line 25 of file bcBaseDeck.h.

Constructor & Destructor Documentation

◆ BCBaseDeck() [1/2]

inp::BCBaseDeck::BCBaseDeck	(	const json &	j = `json({})`,
		std::string	type = `"Force_BC"`
	)

inline

Constructor.

Definition at line 109 of file bcBaseDeck.h.

                                    {}), std::string type = "Force_BC") :
        d_type(type), d_isRegionActive(false), d_isDisplacementZero(false) {
      readFromJson(j, type);
    };

◆ BCBaseDeck() [2/2]

inp::BCBaseDeck::BCBaseDeck	(	bool	isRegionActive,
		geom::GeomData	regionGeomData = `geom::GeomData()`,
		std::vector< size_t >	pList = `std::vector<size_t>()`,
		std::vector< size_t >	pNotList = `std::vector<size_t>()`,
		std::string	timeFnType = `""`,
		std::vector< double >	timeFnParams = `std::vector<double>()`,
		std::string	spatialFnType = `""`,
		std::vector< double >	spatialFnParams = `std::vector<double>()`,
		std::vector< size_t >	direction = `std::vector<size_t>()`,
		bool	isDisplacementZero = `false`
	)

inline

Constructor.

Definition at line 117 of file bcBaseDeck.h.

        : d_isRegionActive(isRegionActive), d_regionGeomData(regionGeomData),
          d_pList(pList), d_pNotList(pNotList), d_timeFnType(timeFnType), d_timeFnParams(timeFnParams),
          d_spatialFnType(spatialFnType), d_spatialFnParams(spatialFnParams),
          d_direction(direction), d_isDisplacementZero(isDisplacementZero) {
 
      // fix selection type
      if (d_isRegionActive) {
        d_selectionType = "region";
        d_isRegionActive = true;
        if (d_pList.size() > 0)
          d_selectionType += "_with_include_list";
 
        if (d_pNotList.size() > 0)
          d_selectionType += "_with_exclude_list";
      } else {
        if (d_pList.size() > 0)
          d_selectionType = "particle";
      }
 
      if (d_isRegionActive) {
        // create a geometry object based on the data
        geom::createGeomObject(d_regionGeomData);
      }
    };

References geom::createGeomObject(), d_isRegionActive, d_pList, d_pNotList, d_regionGeomData, and d_selectionType.

Here is the call graph for this function:

Member Function Documentation

◆ getExampleJson()

static json inp::BCBaseDeck::getExampleJson	(	std::string	type = `"Foce_BC"`,
		bool	isRegionActive = `false`,
		geom::GeomData	regionGeomData = `geom::GeomData()`,
		std::vector< size_t >	pList = `std::vector<size_t>()`,
		std::vector< size_t >	pNotList = `std::vector<size_t>()`,
		std::string	timeFnType = `""`,
		std::vector< double >	timeFnParams = `std::vector<double>()`,
		std::string	spatialFnType = `""`,
		std::vector< double >	spatialFnParams = `std::vector<double>()`,
		std::vector< size_t >	direction = `std::vector<size_t>()`,
		bool	isDisplacementZero = `false`,
		std::string	icType = `""`,
		std::vector< double >	icVec = `std::vector<double>()`
	)

inlinestatic

Returns example JSON object for ModelDeck configuration.

Returns: JSON object with example configuration

Definition at line 157 of file bcBaseDeck.h.

                                                                              {
 
      auto j = json({});
 
      if (isRegionActive) {
        // get json object for geometry
        auto j_geom = json({});
        geom::writeGeometry(j_geom, regionGeomData);
        j["Region"] = {"Geometry", j_geom};
      }
 
      if (pList.size() > 0) j["Particle_List"] = pList;
 
      if (pNotList.size() > 0) j["Particle_Exclude_List"] = pNotList;
 
      if (timeFnType != "") {
        j["Time_Function"] = {"Type", timeFnType};
        if (timeFnParams.size() > 0)
          j["Time_Function"] = {"Parameters", timeFnParams};
      }
 
      if (spatialFnType != "") {
        j["Spatial_Function"] = {"Type", spatialFnType};
        if (spatialFnParams.size() > 0)
          j["Spatial_Function"] = {"Parameters", spatialFnParams};
      }
 
      if (type != "IC") {
        if (direction.size() > 0)
          j["Direction"] = direction;
 
        if (isDisplacementZero) {
          j["Zero_Displacement"] = true;
        }
      }
 
      if (type == "IC") {
        if (icType == "Constant_Velocity") {
          j[icType]["Velocity_Vector"] = icVec;
        }
      }
 
      return j;
    }

References geom::writeGeometry().

Referenced by anonymous_namespace{main.cpp}::buildInputJson(), anonymous_namespace{main.cpp}::buildInputJson(), anonymous_namespace{main.cpp}::buildInputJson(), anonymous_namespace{main.cpp}::buildInputJson(), anonymous_namespace{main.cpp}::buildInputJson(), anonymous_namespace{main.cpp}::buildInputJson(), and getInputJson().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ print()

void inp::BCBaseDeck::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 324 of file bcBaseDeck.h.

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

inp::BCBaseDeck::printStr

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

Returns the string containing printable information about the object.

Definition bcBaseDeck.h:287

References printStr().

Here is the call graph for this function:

◆ printStr()

std::string inp::BCBaseDeck::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 287 of file bcBaseDeck.h.

                                                      {
 
      auto tabS = util::io::getTabS(nt);
      std::ostringstream oss;
      oss << tabS << "------- BCBaseDeck --------" << 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, geom::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 geom::GeomData::printStr().

Referenced by print().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readFromJson()

void inp::BCBaseDeck::readFromJson	(	const json &	j,
		std::string	type
	)

inline

Reads from json object.

Definition at line 217 of file bcBaseDeck.h.

                                                     {
      if (j.empty())
        return;
 
      // fix selection type
      if (j.find("Region") != j.end()) {
        d_selectionType = "region";
        d_isRegionActive = true;
        if (j.find("Particle_List") != j.end())
          d_selectionType += "_with_include_list";
 
        if (j.find("Particle_Exclude_List") != j.end())
          d_selectionType += "_with_exclude_list";
      } else {
        d_isRegionActive = false;
        if (j.find("Particle_List") != j.end())
          d_selectionType = "particle";
      }
 
      if (d_isRegionActive) {
        geom::readGeometry(j.at("Region").at("Geometry"), d_regionGeomData);
        // create a geometry object based on the data
        geom::createGeomObject(d_regionGeomData);
      }
 
      if (j.find("Particle_List") != j.end()) d_pList = j.value("Particle_List", std::vector<size_t>());
 
      if (j.find("Particle_Exclude_List") != j.end())
        d_pNotList = j.value("Particle_Exclude_List", std::vector<size_t>());
 
      if (j.find("Time_Function") != j.end()) {
        d_timeFnType = j.at("Time_Function").value("Type", "");
        if (j.at("Time_Function").find("Parameters") != j.at("Time_Function").end())
          d_timeFnParams = j.at("Time_Function").value("Parameters", std::vector<double>());
      }
 
      if (j.find("Spatial_Function") != j.end()) {
        d_spatialFnType = j.at("Spatial_Function").value("Type", "");
        if (j.at("Spatial_Function").find("Parameters") != j.at("Spatial_Function").end())
          d_spatialFnParams = j.at("Spatial_Function").value("Parameters", std::vector<double>());
      }
 
      if (type != "IC") {
        if (j.find("Direction") == j.end()) {
          throw std::runtime_error("Direction must be specified for boundary condition");
          return;
        }
 
        d_direction = j.value("Direction", std::vector<size_t>());
 
        if (j.find("Zero_Displacement") != j.end())
          d_isDisplacementZero = j.at("Zero_Displacement");
      }
 
      // if it is initial condition
      if (type == "IC") {
        if (j.find("Constant_Velocity") != j.end()) {
          d_icType = "Constant_Velocity";
          d_icVec = util::Point(j.at("Constant_Velocity").value("Velocity_Vector", std::vector<double>({0., 0., 0.})));
        }
      }
    }

References geom::createGeomObject(), d_direction, d_icType, d_icVec, d_isDisplacementZero, d_isRegionActive, d_pList, d_pNotList, d_regionGeomData, d_selectionType, d_spatialFnParams, d_spatialFnType, d_timeFnParams, d_timeFnType, and geom::readGeometry().

Referenced by inp::BCDeck::readFromJson().

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::BCBaseDeck::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 89 of file bcBaseDeck.h.

Referenced by printStr(), and readFromJson().

◆ d_icType

std::string inp::BCBaseDeck::d_icType

Type.

Definition at line 101 of file bcBaseDeck.h.

Referenced by readFromJson().

◆ d_icVec

util::Point inp::BCBaseDeck::d_icVec

Initial velocity vector.

Definition at line 104 of file bcBaseDeck.h.

Referenced by readFromJson().

◆ d_isDisplacementZero

bool inp::BCBaseDeck::d_isDisplacementZero

Specify if this bc corresponds to zero displacement condition.

Definition at line 98 of file bcBaseDeck.h.

Referenced by printStr(), and readFromJson().

◆ d_isRegionActive

bool inp::BCBaseDeck::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 45 of file bcBaseDeck.h.

Referenced by BCBaseDeck(), loading::needToComputeDof(), printStr(), and readFromJson().

◆ d_pList

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

List of particles (if any)

Definition at line 51 of file bcBaseDeck.h.

Referenced by BCBaseDeck(), loading::needToComputeDof(), loading::needToProcessParticle(), printStr(), and readFromJson().

◆ d_pNotList

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

List of particles to not include (if any)

Definition at line 54 of file bcBaseDeck.h.

Referenced by BCBaseDeck(), loading::needToComputeDof(), loading::needToProcessParticle(), printStr(), and readFromJson().

◆ d_regionGeomData

geom::GeomData inp::BCBaseDeck::d_regionGeomData

Region geometry (if any)

Definition at line 48 of file bcBaseDeck.h.

Referenced by BCBaseDeck(), loading::needToComputeDof(), printStr(), and readFromJson().

◆ d_selectionType

std::string inp::BCBaseDeck::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 38 of file bcBaseDeck.h.

Referenced by BCBaseDeck(), loading::needToComputeDof(), loading::needToProcessParticle(), printStr(), and readFromJson().

◆ d_spatialFnParams

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

List of parameters for function wrt spatial coordinate.

Definition at line 95 of file bcBaseDeck.h.

Referenced by printStr(), and readFromJson().

◆ d_spatialFnType

std::string inp::BCBaseDeck::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 80 of file bcBaseDeck.h.

Referenced by printStr(), and readFromJson().

◆ d_timeFnParams

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

List of parameters for function wrt time.

Definition at line 92 of file bcBaseDeck.h.

Referenced by printStr(), and readFromJson().

◆ d_timeFnType

std::string inp::BCBaseDeck::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 67 of file bcBaseDeck.h.

Referenced by printStr(), and readFromJson().

◆ d_type

std::string inp::BCBaseDeck::d_type

Method for applying force. E.g., Force_BC, Displacement_BC, IC.

Definition at line 27 of file bcBaseDeck.h.

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

/home/user/project/src/inp/bcBaseDeck.h

Public Member Functions

Static Public Member Functions

Data Fields

Detailed Description

Constructor & Destructor Documentation

◆ BCBaseDeck() [1/2]

◆ BCBaseDeck() [2/2]

Member Function Documentation

◆ getExampleJson()

◆ print()

◆ printStr()

◆ readFromJson()

Field Documentation

◆ d_direction

◆ d_icType

◆ d_icVec

◆ d_isDisplacementZero

◆ d_isRegionActive

◆ d_pList

◆ d_pNotList

◆ d_regionGeomData

◆ d_selectionType

◆ d_spatialFnParams

◆ d_spatialFnType

◆ d_timeFnParams

◆ d_timeFnType

◆ d_type