inp::BCDeck Struct Reference

Structure to read and store test-related input data. More...

#include <bcDeck.h>

Collaboration diagram for inp::BCDeck:

Public Member Functions
	BCDeck (const json &j=json({}))
	Constructor.
	BCDeck (size_t nForceSets, size_t nDispSets=0, size_t nICSets=0, bool gravityActive=false, util::Point gravity=util::Point())
	Constructor.
void	readFromJson (const json &j)
	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 (const json &given=json::object())
	Returns example JSON object for ModelDeck configuration.

Data Fields
std::vector< inp::BCBaseDeck >	d_forceDeck
	Force loading deck.
std::vector< inp::BCBaseDeck >	d_dispDeck
	Displacement loading deck.
std::vector< inp::BCBaseDeck >	d_icDeck
	Initial condition deck.
bool	d_gravityActive
	Gravity loading value.
util::Point	d_gravity
	Gravity loading value.

Detailed Description

Structure to read and store test-related input data.

Definition at line 27 of file bcDeck.h.

Constructor & Destructor Documentation

BCDeck() [1/2]

inp::BCDeck::BCDeck ( const json &  j = json({}) )

inline

Constructor.

Definition at line 48 of file bcDeck.h.

                                {}))
      : d_gravityActive(false) {
      readFromJson(j);
    };

BCDeck() [2/2]

inp::BCDeck::BCDeck ( size_t  nForceSets, size_t  nDispSets = 0, size_t  nICSets = 0, bool  gravityActive = false, util::Point  gravity = util::Point()  )

inline

Constructor.

Definition at line 56 of file bcDeck.h.

        : d_gravityActive(gravityActive), d_gravity(gravity) {
 
        d_forceDeck.resize(nForceSets);
        d_dispDeck.resize(nDispSets);
        d_icDeck.resize(nICSets);
    };

References d_dispDeck, d_forceDeck, and d_icDeck.

Member Function Documentation

getExampleJson()

static json inp::BCDeck::getExampleJson ( const json &  given = json::object() )

inlinestatic

Returns example JSON object for ModelDeck configuration.

Returns

JSON object with example configuration

Returns the block with the given fields set

Each of the three kinds of set is asked for by its count. Naming Gravity is what turns gravity on; it is a force on every particle and so sits beside the force sets rather than replacing them.

Parameters

given

Force_BC_Sets, Displacement_BC_Sets, IC_Sets and Gravity

Returns

JSON object for this deck

Definition at line 79 of file bcDeck.h.

                                                                 {
      checkNames(given, {"Force_BC_Sets", "Displacement_BC_Sets", "IC_Sets",
                         "Gravity"});
 
      const auto nForceSets = given.value("Force_BC_Sets", size_t(0));
      const auto nDispSets = given.value("Displacement_BC_Sets", size_t(0));
      const auto nICSets = given.value("IC_Sets", size_t(0));
      const bool gravityActive = given.find("Gravity") != given.end();
 
      if (nForceSets + nDispSets + nICSets == 0 and !gravityActive)
        return json({});
 
      auto j = json({});
 
      if (gravityActive)
        j["Force_BC"]["Gravity"] = given.at("Gravity");
 
      if (nForceSets > 0)
        j["Force_BC"]["Sets"] = nForceSets;
 
      if (nDispSets > 0)
        j["Displacement_BC"] = {{"Sets", nDispSets}};
 
      if (nICSets > 0)
        j["IC"] = {{"Sets", nICSets}};
 
      return j;
    }

References inp::checkNames().

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(), anonymous_namespace{main.cpp}::buildInputJson(), getInputJson(), and anonymous_namespace{testDeckRoundTrip.cpp}::testBCDeck().

Here is the call graph for this function:

Here is the caller graph for this function:

print()

void inp::BCDeck::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 200 of file bcDeck.h.

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

References printStr().

Here is the call graph for this function:

printStr()

std::string inp::BCDeck::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 162 of file bcDeck.h.

                                                      {
      auto tabS = util::io::getTabS(nt);
      std::ostringstream oss;
      oss << tabS << "------- BCDeck --------" << std::endl << std::endl;
      oss << tabS << "Force loading deck size = " << d_forceDeck.size() << std::endl;
      oss << tabS << "Force loading data:" << std::endl;
      for (size_t i = 0; i < d_forceDeck.size(); i++) {
        oss << tabS << "Force data for set = " << i << std::endl;
        oss << d_forceDeck[i].printStr(nt + 1, lvl);
      }
 
      oss << tabS << "Displacement loading deck size = " << d_dispDeck.size() << std::endl;
      oss << tabS << "Displacement loading data:" << std::endl;
      for (size_t i = 0; i < d_dispDeck.size(); i++) {
        oss << tabS << "Displacement data for set = " << i << std::endl;
        oss << d_dispDeck[i].printStr(nt + 1, lvl);
      }
 
      oss << tabS << "Initial condition deck size = " << d_icDeck.size() << std::endl;
      oss << tabS << "Initial condition data:" << std::endl;
      for (size_t i = 0; i < d_icDeck.size(); i++) {
        oss << tabS << "Initial condition for set = " << i << std::endl;
        oss << d_icDeck[i].printStr(nt + 1, lvl);
      }
 
      oss << tabS << "Gravity loading active = " << d_gravityActive << std::endl;
      oss << tabS << "Gravity loading value = " << d_gravity.printStr(0, 0) << std::endl;
      oss << tabS << std::endl;
 
      return oss.str();
    }

References d_dispDeck, d_forceDeck, d_gravity, d_gravityActive, d_icDeck, util::io::getTabS(), and util::Point::printStr().

Referenced by print().

Here is the call graph for this function:

Here is the caller graph for this function:

readFromJson()

void inp::BCDeck::readFromJson ( const json &  j )

inline

Reads from json object.

Definition at line 111 of file bcDeck.h.

                                     {
 
      if (j.empty())
        return;
 
      // gravity
      if (j.find("Force_BC") != j.end()) {
        if (j.at("Force_BC").find("Gravity") != j.at("Force_BC").end()) {
          d_gravityActive = true;
          d_gravity = util::Point(j.at("Force_BC").value("Gravity", std::vector<double>({0., 0., 0.})));
        }
      }
 
      // process Force_BC
      d_forceDeck.clear();
      d_dispDeck.clear();
      d_icDeck.clear();
      for (auto tag : std::vector<std::string>({"Force_BC", "Displacement_BC", "IC"})) {
        if (j.find(tag) == j.end())
          continue;
 
        auto nSets = j.at(tag).value("Sets", 0);
 
        for (size_t i = 0; i < nSets; i++) {
 
          auto set = j.at(tag).at("Set_" + std::to_string(i + 1));
 
          if (tag == "Force_BC") {
            inp::BCBaseDeck bcData;
            bcData.readFromJson(set, tag);
            d_forceDeck.push_back(bcData);
          } else if (tag == "Displacement_BC") {
            inp::BCBaseDeck bcData;
            bcData.readFromJson(set, tag);
            d_dispDeck.push_back(bcData);
          } else if (tag == "IC") {
            inp::BCBaseDeck icData;
            icData.readFromJson(set, tag);
            d_icDeck.push_back(icData);
          }
        } // loop over sets
      } // loop over tag
    }

References d_dispDeck, d_forceDeck, d_gravity, d_gravityActive, d_icDeck, and inp::BCBaseDeck::readFromJson().

Here is the call graph for this function:

Field Documentation

d_dispDeck

std::vector<inp::BCBaseDeck> inp::BCDeck::d_dispDeck

Displacement loading deck.

Definition at line 33 of file bcDeck.h.

Referenced by BCDeck(), printStr(), and readFromJson().

d_forceDeck

std::vector<inp::BCBaseDeck> inp::BCDeck::d_forceDeck

Force loading deck.

Definition at line 30 of file bcDeck.h.

Referenced by BCDeck(), printStr(), and readFromJson().

d_gravity

util::Point inp::BCDeck::d_gravity

Gravity loading value.

Definition at line 42 of file bcDeck.h.

Referenced by printStr(), and readFromJson().

d_gravityActive

bool inp::BCDeck::d_gravityActive

Gravity loading value.

Definition at line 39 of file bcDeck.h.

Referenced by printStr(), and readFromJson().

d_icDeck

std::vector<inp::BCBaseDeck> inp::BCDeck::d_icDeck

Initial condition deck.

Definition at line 36 of file bcDeck.h.

Referenced by BCDeck(), printStr(), and readFromJson().

---

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

• /home/user/project/src/inp/bcDeck.h