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

#include <contactPairDeck.h>

Collaboration diagram for inp::ContactPairDeck:

Public Member Functions
	ContactPairDeck (const json &j=json({}))
	Constructor.

	ContactPairDeck (double contactR, bool computeContactR=true, bool dampingOn=true, bool frictionOn=true, double Kn=0., double eps=1., double mu=0., double KnFactor=1., double betanFactor=1., double deltaMax=1., double vMax=0.)
	Constructor.

	ContactPairDeck (const ContactPairDeck &cd)
	Copy 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 const std::vector< Field< ContactPairDeck > > &	fields ()
	The fields of this deck, declared once.

static const std::vector< OneOf > &	groups ()
	Quantities this deck accepts in more than one form.

static json	getExampleJson (const json &given=json::object())
	Returns example JSON object for ModelDeck configuration.

Data Fields
double	d_contactR
	contact radius

bool	d_computeContactR
	Flag that indicates whether contact radius is to be computed.


double	d_vMax
	parameters for normal force

double	d_deltaMax
	parameters for normal force

double	d_Kn
	parameters for normal force

double	d_KnFactor
	parameters for normal force


double	d_eps
	parameters for normal damping force

double	d_betan
	parameters for normal damping force

bool	d_dampingOn
	parameters for normal damping force

double	d_betanFactor
	parameters for normal damping force


double	d_mu
	parameters for frictional force

bool	d_frictionOn
	parameters for frictional force

double	d_K
	parameters for frictional force

Detailed Description

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

Definition at line 27 of file contactPairDeck.h.

Constructor & Destructor Documentation

◆ ContactPairDeck() [1/3]

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

inline

Constructor.

Definition at line 61 of file contactPairDeck.h.

                                         {}))
      : d_contactR(0.), d_computeContactR(true), d_vMax(0.), d_deltaMax(0.),
        d_Kn(0.), d_eps(1.), d_betan(0.), d_mu(0.), d_dampingOn(true),
        d_frictionOn(true), d_KnFactor(1.), d_betanFactor(1.), d_K(0.) {
      readFromJson(j);
    };

◆ ContactPairDeck() [2/3]

inp::ContactPairDeck::ContactPairDeck	(	double	contactR,
		bool	computeContactR = `true`,
		bool	dampingOn = `true`,
		bool	frictionOn = `true`,
		double	Kn = `0.`,
		double	eps = `1.`,
		double	mu = `0.`,
		double	KnFactor = `1.`,
		double	betanFactor = `1.`,
		double	deltaMax = `1.`,
		double	vMax = `0.`
	)

inline

Constructor.

Definition at line 71 of file contactPairDeck.h.

        : d_contactR(contactR), d_computeContactR(computeContactR), d_vMax(vMax), d_deltaMax(deltaMax),
          d_Kn(Kn), d_eps(eps), d_betan(0.), d_mu(mu), d_dampingOn(dampingOn),
          d_frictionOn(frictionOn), d_KnFactor(KnFactor), d_betanFactor(betanFactor), d_K(0.) {
    };

◆ ContactPairDeck() [3/3]

inp::ContactPairDeck::ContactPairDeck ( const ContactPairDeck & cd )

inline

Copy constructor.

Parameters

cd	Another ContactPairDeck object

Definition at line 86 of file contactPairDeck.h.

      : d_contactR(cd.d_contactR), d_computeContactR(cd.d_computeContactR),
        d_vMax(cd.d_vMax), d_deltaMax(cd.d_deltaMax),
        d_Kn(cd.d_Kn), d_eps(cd.d_eps), d_betan(cd.d_betan),
        d_mu(cd.d_mu), d_dampingOn(cd.d_dampingOn),
        d_frictionOn(cd.d_frictionOn), d_KnFactor(cd.d_KnFactor),
        d_betanFactor(cd.d_betanFactor), d_K(cd.d_K) {
    };

Member Function Documentation

◆ fields()

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

inlinestatic

The fields of this deck, declared once.

The contact radius and the contact stiffness are each given in one of two ways and are resolved in readFromJson. What remains maps one key to one member.

Returns: fields The field table

Definition at line 104 of file contactPairDeck.h.

                                                             {
      static const std::vector<Field<ContactPairDeck>> f = {
          field(&ContactPairDeck::d_KnFactor, "Kn_Factor", 1.,
                "Normal stiffness is scaled by this"),
          field(&ContactPairDeck::d_dampingOn, "Damping_On", true,
                "Apply the normal damping force"),
          field(&ContactPairDeck::d_eps, "Epsilon", 1.,
                "Coefficient of restitution", {{}, 0., 1.}),
          field(&ContactPairDeck::d_betanFactor, "Beta_n_Factor", 1.,
                "Damping coefficient is scaled by this"),
          field(&ContactPairDeck::d_frictionOn, "Friction_On", true,
                "Apply the tangential friction force"),
          field(&ContactPairDeck::d_mu, "Friction_Coeff", 0.,
                "Coefficient of friction"),
          // Left out when it is not set, because a pair without friction
          // does not use it.
          field<ContactPairDeck, double>(
              &ContactPairDeck::d_K, "K", 0.,
              "Bulk modulus the tangential force is built from", {},
              [](const double &v) { return v > 1.E-10; }),
      };
      return f;
    }

References d_betanFactor, d_dampingOn, d_eps, d_frictionOn, d_K, d_KnFactor, d_mu, and inp::field().

Referenced by getExampleJson(), and readFromJson().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getExampleJson()

static json inp::ContactPairDeck::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

The contact radius is given either as Contact_Radius, an absolute length, or as Contact_Radius_Factor, a multiple of the mesh size. The contact stiffness is given either as Kn, or as V_Max with an optional Delta_Max, the speed and overlap the stiffness is derived from. Naming one of each pair is what selects it; there is no flag and no value standing in for "not set".

Parameters

given Field names and values to set, checked against the table

Returns: JSON object for this deck

Definition at line 158 of file contactPairDeck.h.

                                                                 {
      const std::vector<std::string> extra = {"Contact_Radius",
                                              "Contact_Radius_Factor", "Kn",
                                              "V_Max", "Delta_Max"};
      checkKeys(given, fields(), extra);
 
      json g = given;
 
      // Damping with no coefficient is no damping.
      bool dampingOn = g.value("Damping_On", true);
      double betanFactor = g.value("Beta_n_Factor", 1.);
      if (dampingOn and betanFactor < 1.E-10)
        dampingOn = false;
      if (!dampingOn)
        betanFactor = 0.;
      g["Damping_On"] = dampingOn;
      g["Beta_n_Factor"] = betanFactor;
 
      if (g.value("Friction_On", true) and
          g.value("Friction_Coeff", 0.) < 1.E-10)
        throw std::runtime_error("Friction coefficient can not be zero.");
 
      if (g.find("Contact_Radius_Factor") != g.end() and
          g.at("Contact_Radius_Factor").get<double>() < 1.E-10)
        throw std::runtime_error("Contact radius factor can not be zero.");
 
      if (g.find("Kn") != g.end() and g.at("Kn").get<double>() < 1.E-10)
        throw std::runtime_error(
            "Kn can not be zero. Give V_Max instead to derive it.");
 
      // The speed is what the stiffness is derived from, so the overlap it
      // is measured against goes with it.
      if (g.find("V_Max") != g.end()) {
        if (g.at("V_Max").get<double>() < 1.E-10)
          throw std::runtime_error(
              "Need V_Max parameter for contact force.");
        if (g.find("Delta_Max") == g.end() or
            g.at("Delta_Max").get<double>() < 1.E-10)
          g["Delta_Max"] = 1.;
      }
 
      json j = applyGiven(g, fields(), extra);
      checkGroups(j, groups());
      return j;
    }

References inp::applyGiven(), inp::checkGroups(), inp::checkKeys(), fields(), and groups().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ groups()

static const std::vector< OneOf > & inp::ContactPairDeck::groups ( )

inlinestatic

Quantities this deck accepts in more than one form.

Returns: groups The groups

Definition at line 132 of file contactPairDeck.h.

                                            {
      static const std::vector<OneOf> g = {
          {"the contact radius",
           {"Contact_Radius", "Contact_Radius_Factor"}},
          {"the contact stiffness", {"Kn", "V_Max"}},
      };
      return g;
    }

Referenced by getExampleJson(), and readFromJson().

Here is the caller graph for this function:

◆ print()

void inp::ContactPairDeck::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 277 of file contactPairDeck.h.

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

inp::ContactPairDeck::printStr

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

Returns the string containing printable information about the object.

Definition contactPairDeck.h:254

References printStr().

Here is the call graph for this function:

◆ printStr()

std::string inp::ContactPairDeck::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 254 of file contactPairDeck.h.

                                                      {
      auto tabS = util::io::getTabS(nt);
      std::ostringstream oss;
      oss << tabS << "------- ContactPairDeck --------" << std::endl << std::endl;
      oss << tabS << "Contact radius = " << d_contactR << std::endl;
      oss << tabS << "v_max = " << d_vMax << ", Delta_max = " << d_deltaMax
          << ", Kn = " << d_Kn << std::endl;
      oss << tabS << "epsilon = " << d_eps << ", Beta_n = " << d_betan << std::endl;
      oss << tabS << "Friction coefficient = " << d_mu << std::endl;
      oss << tabS << "Damping status = " << d_dampingOn << std::endl;
      oss << tabS << "Kn factor = " << d_KnFactor
          << ", Beta n factor = " << d_betanFactor << std::endl;
      oss << tabS << "Bulk modulus = " << d_K << std::endl;
      oss << tabS << std::endl;
      return oss.str();
    }

References d_betan, d_betanFactor, d_contactR, d_dampingOn, d_deltaMax, d_eps, d_K, d_Kn, d_KnFactor, d_mu, d_vMax, and util::io::getTabS().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readFromJson()

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

inline

Reads from json object.

Definition at line 207 of file contactPairDeck.h.

                                     {
 
      if (j.empty())
        return;
 
      checkGroups(j, groups());
      readFields(*this, j, fields());
 
      // A factor is applied to the mesh size, an absolute radius is not.
      d_computeContactR = j.find("Contact_Radius_Factor") != j.end();
      d_contactR = d_computeContactR ? j.at("Contact_Radius_Factor").get<double>()
                                     : j.at("Contact_Radius").get<double>();
 
      // Given a stiffness, the speed that produces the reference overlap
      // follows from it. Given that speed instead, the stiffness follows in
      // the contact force.
      if (j.find("Kn") != j.end()) {
        d_Kn = j.at("Kn");
        d_deltaMax = 1.;
        d_vMax = std::sqrt(d_Kn);
      } else {
        d_vMax = j.at("V_Max");
        d_deltaMax = j.value("Delta_Max", 1.);
      }
 
      if (d_betanFactor < 1.E-8)
        d_dampingOn = false;
 
      if (!d_dampingOn)
        d_betanFactor = 0.;
 
      if (d_frictionOn and d_mu < 1.E-10) {
        throw std::runtime_error("Friction coefficient can not be zero.");
      }
      if (d_frictionOn and d_K < 1.E-10) {
        throw std::runtime_error("Bulk modulus can not be zero.");
      }
    }

References inp::checkGroups(), d_betanFactor, d_computeContactR, d_contactR, d_dampingOn, d_deltaMax, d_frictionOn, d_K, d_Kn, d_mu, d_vMax, fields(), groups(), and inp::readFields().

Referenced by anonymous_namespace{testDeckRoundTrip.cpp}::testContactPairDeck().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ d_betan

double inp::ContactPairDeck::d_betan

parameters for normal damping force

Definition at line 46 of file contactPairDeck.h.

Referenced by main(), contact::PairForce::nodeDampingForce(), printStr(), and contact::Contact::setup().

◆ d_betanFactor

double inp::ContactPairDeck::d_betanFactor

parameters for normal damping force

Definition at line 48 of file contactPairDeck.h.

Referenced by fields(), printStr(), readFromJson(), and contact::Contact::setup().

◆ d_computeContactR

bool inp::ContactPairDeck::d_computeContactR

Flag that indicates whether contact radius is to be computed.

Definition at line 33 of file contactPairDeck.h.

Referenced by readFromJson(), and contact::Contact::setup().

◆ d_contactR

double inp::ContactPairDeck::d_contactR

contact radius

Definition at line 30 of file contactPairDeck.h.

Referenced by contact::PairForce::nodeDampingForce(), printStr(), readFromJson(), contact::Contact::setup(), contact::PairForce::springForce(), and contact::StickSlipPairForce::springForce().

◆ d_dampingOn

bool inp::ContactPairDeck::d_dampingOn

parameters for normal damping force

Definition at line 47 of file contactPairDeck.h.

Referenced by fields(), contact::PairForce::nodeDampingForce(), printStr(), and readFromJson().

◆ d_deltaMax

double inp::ContactPairDeck::d_deltaMax

parameters for normal force

Definition at line 38 of file contactPairDeck.h.

Referenced by printStr(), and readFromJson().

◆ d_eps

double inp::ContactPairDeck::d_eps

parameters for normal damping force

Definition at line 45 of file contactPairDeck.h.

Referenced by fields(), printStr(), and contact::Contact::setup().

◆ d_frictionOn

bool inp::ContactPairDeck::d_frictionOn

parameters for frictional force

Definition at line 54 of file contactPairDeck.h.

Referenced by fields(), readFromJson(), contact::PairForce::springForce(), and contact::StickSlipPairForce::springForce().

◆ d_K

double inp::ContactPairDeck::d_K

parameters for frictional force

Definition at line 55 of file contactPairDeck.h.

Referenced by fields(), main(), contact::PairForce::nodeDampingForce(), printStr(), readFromJson(), and contact::Contact::setup().

◆ d_Kn

double inp::ContactPairDeck::d_Kn

parameters for normal force

Definition at line 39 of file contactPairDeck.h.

Referenced by printStr(), readFromJson(), contact::Contact::setup(), contact::PairForce::springForce(), and contact::StickSlipPairForce::springForce().

◆ d_KnFactor

double inp::ContactPairDeck::d_KnFactor

parameters for normal force

Definition at line 40 of file contactPairDeck.h.

Referenced by fields(), printStr(), and contact::Contact::setup().

◆ d_mu

double inp::ContactPairDeck::d_mu

parameters for frictional force

Definition at line 53 of file contactPairDeck.h.

Referenced by fields(), printStr(), readFromJson(), contact::Contact::setup(), contact::PairForce::springForce(), and contact::StickSlipPairForce::springForce().

◆ d_vMax

double inp::ContactPairDeck::d_vMax

parameters for normal force

Definition at line 37 of file contactPairDeck.h.

Referenced by printStr(), readFromJson(), and contact::Contact::setup().

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

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

Public Member Functions

Static Public Member Functions

Data Fields

Detailed Description

Constructor & Destructor Documentation

◆ ContactPairDeck() [1/3]

◆ ContactPairDeck() [2/3]

◆ ContactPairDeck() [3/3]

Member Function Documentation

◆ fields()

◆ getExampleJson()

◆ groups()

◆ print()

◆ printStr()

◆ readFromJson()

Field Documentation

◆ d_betan

◆ d_betanFactor

◆ d_computeContactR

◆ d_contactR

◆ d_dampingOn

◆ d_deltaMax

◆ d_eps

◆ d_frictionOn

◆ d_K

◆ d_Kn

◆ d_KnFactor

◆ d_mu

◆ d_vMax