pNeighborDeck.h

Go to the documentation of this file.

/*
 * -------------------------------------------
 * Copyright (c) 2021 - 2026 Prashant K. Jha
 * -------------------------------------------
 * PeriDEM https://github.com/prashjha/PeriDEM
 *
 * Distributed under the Boost Software License, Version 1.0. (See accompanying
 * file LICENSE)
 */
 
#ifndef INP_PNEIGHBORDECK_H
#define INP_PNEIGHBORDECK_H
 
#include "util/io.h"
#include "deckField.h"
#include "util/json.h"
 
namespace inp {
 
struct PNeighborDeck {
 
  std::string d_updateCriteria;
 
  double d_sFactor;
 
  size_t d_neighUpdateInterval;
 
  double d_nearBdNodesTol;
 
  PNeighborDeck(const json &j = json({}))
      : d_updateCriteria("simple_all"),
        d_sFactor(1.),
        d_neighUpdateInterval(1),
        d_nearBdNodesTol(0.5) {
    readFromJson(j);
  };
 
  PNeighborDeck(std::string updateCriteria, double sFactor = 1.,
                size_t neighUpdateInterval = 1, double nearBdNodesTol = 0.5)
      : d_updateCriteria(updateCriteria),
        d_sFactor(sFactor),
        d_neighUpdateInterval(neighUpdateInterval),
        d_nearBdNodesTol(nearBdNodesTol) {};
 
  static const std::vector<Field<PNeighborDeck>> &fields() {
    static const std::vector<Field<PNeighborDeck>> f = {
        field(&PNeighborDeck::d_updateCriteria, "Update_Criteria",
              std::string("simple_all"),
              "When the contact neighbor list is rebuilt"),
        field(&PNeighborDeck::d_sFactor, "Search_Factor", 1.,
              "Search length as a multiple of the largest particle radius"),
        field(&PNeighborDeck::d_neighUpdateInterval, "Search_Interval",
              size_t(1), "Steps between contact neighbor list updates"),
        field(&PNeighborDeck::d_nearBdNodesTol, "Near_Bd_Nodes_Tol", 0.5,
              "Depth within which a node counts as near the boundary"),
    };
    return f;
  }
 
  static json getExampleJson(const json &given = json::object()) {
    return applyGiven(given, fields());
  }
 
  static json getExampleJson(const std::string &) = delete;
  static json getExampleJson(const char *) = delete;
 
  void readFromJson(const json &j) {
    if (j.empty())
      return;
    readFields(*this, j, fields());
  }
 
  json writeToJson() const {
    json j = json::object();
    writeFields(*this, j, fields());
    return j;
  }
 
  std::string printStr(int nt = 0, int lvl = 0) const {
 
    auto tabS = util::io::getTabS(nt);
    std::ostringstream oss;
    oss << tabS << "------- PNeighborDeck --------" << std::endl << std::endl;
    printFields(*this, oss, fields(), tabS);
    oss << tabS << std::endl;
 
    return oss.str();
  }
 
  void print(int nt = 0, int lvl = 0) const { std::cout << printStr(nt, lvl); }
};
 
} // namespace inp
 
#endif // INP_PNEIGHBORDECK_H