inp::ContactDeck Struct Reference

Structure to read and store particle-particle contact related input data. More...

#include <contactDeck.h>

Collaboration diagram for inp::ContactDeck:

Public Member Functions
	ContactDeck (const json &j=json({}))
	Constructor.
const ContactPairDeck &	getContact (const size_t &i, const size_t &j) const
	Returns the contact data.
ContactPairDeck &	getContact (const size_t &i, const size_t &j)
	Returns the contact data.
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 const std::vector< Field< ContactDeck > > &	fields ()
	Returns example JSON object for ModelDeck configuration.
static json	getExampleJson (const json &given=json::object())
	Returns the block with the given fields set.

Data Fields
std::vector< std::vector< ContactPairDeck > >	d_data
	Store contact parameters for each pair of zone.
std::string	d_dampingLaw
	Contact damping law name (default com_and_node).
std::string	d_frictionLaw
	Friction law name (default coulomb_simple).
bool	d_correctVolume
	If true (default), DEM contact uses partial neighbor volume near the contact radius (correctedContactVolume). Set false to use full nodal volume (main-branch DEM contact spring).

Detailed Description

Structure to read and store particle-particle contact related input data.

Definition at line 27 of file contactDeck.h.

Constructor & Destructor Documentation

ContactDeck()

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

inline

Constructor.

Definition at line 50 of file contactDeck.h.

                                   {}))
      : d_dampingLaw("com_and_node"), d_frictionLaw("coulomb_simple"),
        d_correctVolume(true) {
    readFromJson(j);
  };

Member Function Documentation

fields()

static const std::vector< Field< ContactDeck > > & inp::ContactDeck::fields ( )

inlinestatic

Returns example JSON object for ModelDeck configuration.

Returns

JSON object with example configuration

Definition at line 78 of file contactDeck.h.

                                                       {
    static const std::vector<Field<ContactDeck>> f = {
        field(&ContactDeck::d_dampingLaw, "Damping_Law",
              std::string("com_and_node"), "Where contact damping is applied",
              {{"com_and_node", "com", "node", "off"}, {}, {}}),
        field(&ContactDeck::d_frictionLaw, "Friction_Law",
              std::string("coulomb_simple"), "Tangential contact law",
              {{"coulomb_simple", "stick_slip"}, {}, {}}),
        field(&ContactDeck::d_correctVolume, "Correct_Volume", true,
              "Scale the neighbor volume by the overlap with the contact "
              "sphere"),
    };
    return f;
  }

References d_correctVolume, d_dampingLaw, d_frictionLaw, and inp::field().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getContact() [1/2]

ContactPairDeck & inp::ContactDeck::getContact ( const size_t &  i, const size_t &  j  )

inline

Returns the contact data.

Parameters

i	Zone i
j	Zone j

Returns

data Contact data between zone i and j

Definition at line 69 of file contactDeck.h.

                                                                {
    //return d_data[i < j ? i : j][i < j ? j : i];
    return d_data[i][j];
  }

References d_data.

getContact() [2/2]

const ContactPairDeck & inp::ContactDeck::getContact ( const size_t &  i, const size_t &  j  ) const

inline

Returns the contact data.

Parameters

i	Zone i
j	Zone j

Returns

data Contact data between zone i and j

Definition at line 63 of file contactDeck.h.

                                                                            {
    //return d_data[i < j ? i : j][i < j ? j : i];
    return d_data[i][j];
  }

References d_data.

Referenced by printStr().

Here is the caller graph for this function:

getExampleJson()

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

inlinestatic

Returns the block with the given fields set.

One pair block is written for each pair of contact groups. Without any groups the block is empty.

Parameters

given

Field names and values to set, checked against the table, and Sets, the number of contact groups

Returns

JSON object for this deck

Definition at line 103 of file contactDeck.h.

                                                               {
    json j = applyGiven(given, fields(), {"Sets"});
    const auto nSets = j.value("Sets", size_t(0));
    if (nSets == 0)
      return json({});
 
    for (size_t i = 0; i < nSets; i++)
      for (size_t k = i; k < nSets; k++)
        j["Set_" + std::to_string(i + 1) + "_" + std::to_string(k + 1)] = {};
 
    return j;
  }

References inp::applyGiven(), and fields().

Referenced by anonymous_namespace{main.cpp}::buildInputJson(), inp::ParticleDeck::getParticleContactExampleJson(), and anonymous_namespace{testDeckRoundTrip.cpp}::testContactDeck().

Here is the call graph for this function:

Here is the caller graph for this function:

print()

void inp::ContactDeck::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 197 of file contactDeck.h.

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

References printStr().

Here is the call graph for this function:

printStr()

std::string inp::ContactDeck::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 172 of file contactDeck.h.

                                                    {
 
    auto tabS = util::io::getTabS(nt);
    std::ostringstream oss;
    oss << tabS << "------- ContactDeck --------" << std::endl << std::endl;
    printFields(*this, oss, fields(), tabS);
    for (size_t i =0; i<d_data.size(); i++) {
      for (size_t j = 0; j < d_data.size(); j++) {
        oss << tabS << "ContactPairData id = (" << i << "," << j << ") info:"
                  << std::endl;
        oss << getContact(i,j).printStr(nt+2, lvl);
      }
    }
 
    oss << tabS << std::endl;
 
    return oss.str();
  }

References d_data, fields(), getContact(), util::io::getTabS(), inp::printFields(), and inp::ContactPairDeck::printStr().

Referenced by print(), and inp::ParticleDeck::printStr().

Here is the call graph for this function:

Here is the caller graph for this function:

readFromJson()

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

inline

Reads from json object.

Definition at line 119 of file contactDeck.h.

                                   {
    if (j.empty())
      return;
 
    readFields(*this, j, fields());
 
    auto nSets = j.value("Sets", size_t(0));
    d_data.resize(nSets);
    for (size_t i=0; i<nSets; i++)
      d_data[i].resize(nSets);
 
    for (size_t i = 0; i < nSets; i++) {
      for (size_t k = i; k < nSets; k++) {
        std::string set_name = "Set_" + std::to_string(i+1) + "_" + std::to_string(k+1);
        //std::cout << "\n\n\n processing " << set_name << "\n\n\n" << std::flush;
 
        auto cd = inp::ContactPairDeck();
 
        if (j.find(set_name) == j.end())
          throw std::runtime_error("Set " + set_name + " not found in contact block.");
 
        auto js = j.at(set_name);
 
        // copy this set from previous set?
        std::vector<int> copy_set = js.value("Copy_Data", std::vector<int>({-1, -1}));
        //std::cout << "copy_data = " << copy_set[0] << ", " << copy_set[1] << "\n" << std::flush;
 
        // check
        if ((copy_set[0] != -1 and copy_set[1] == -1) or (copy_set[0] == -1 and copy_set[1] != -1) or (copy_set.size() != 2))
          throw std::runtime_error("The pair of set ids for copying is invalid in contact block.");
 
        if (copy_set[0] != -1) {
          std::string copy_set_tag = "Set_" + std::to_string(copy_set[0]) + "_" + std::to_string(copy_set[1]);
          auto js_copy = j.at(copy_set_tag);
          cd.readFromJson(js_copy);
        } else {
          cd.readFromJson(js);
        }
 
        d_data[i][k] = cd;
        if (i != k)
          d_data[k][i] = cd;
      }
    }
  }

References d_data, fields(), and inp::readFields().

Referenced by inp::ParticleDeck::readParticleContactFromJson().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

d_correctVolume

bool inp::ContactDeck::d_correctVolume

If true (default), DEM contact uses partial neighbor volume near the contact radius (correctedContactVolume). Set false to use full nodal volume (main-branch DEM contact spring).

Definition at line 45 of file contactDeck.h.

Referenced by fields().

d_dampingLaw

std::string inp::ContactDeck::d_dampingLaw

Contact damping law name (default com_and_node).

Definition at line 35 of file contactDeck.h.

Referenced by fields().

d_data

std::vector<std::vector<ContactPairDeck> > inp::ContactDeck::d_data

Store contact parameters for each pair of zone.

Definition at line 32 of file contactDeck.h.

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

d_frictionLaw

std::string inp::ContactDeck::d_frictionLaw

Friction law name (default coulomb_simple).

Definition at line 38 of file contactDeck.h.

Referenced by fields().

---

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

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