Performs XML configuration and holds configured mappings.
More...
#include <MappingConfiguration.hpp>
|
ConfiguredMapping | createMapping (const std::string &direction, const std::string &type, const std::string &fromMeshName, const std::string &toMeshName, const std::string &geoMultiscaleType, const std::string &geoMultiscaleAxis, const double &multiscaleRadius) const |
|
RBFConfiguration | configureRBFMapping (const std::string &type, const std::string &polynomial, bool xDead, bool yDead, bool zDead, double solverRtol, double verticesPerCluster, double relativeOverlap, bool projectToInput) const |
|
void | finishRBFConfiguration () |
|
void | checkDuplicates (const ConfiguredMapping &mapping) |
| Check whether a mapping to and from the same mesh already exists.
|
|
bool | requiresBasisFunction (const std::string &mappingType) const |
|
BasisFunction | parseBasisFunctions (const std::string &basisFctName) const |
| Given a basis function name (as a string), transforms the string into an enum of the BasisFunction.
|
|
Performs XML configuration and holds configured mappings.
Definition at line 15 of file MappingConfiguration.hpp.
◆ Direction
◆ MappingConfiguration()
◆ checkDuplicates()
void precice::mapping::MappingConfiguration::checkDuplicates |
( |
const ConfiguredMapping & | mapping | ) |
|
|
private |
◆ configureRBFMapping()
Stores additional information about the requested RBF mapping such as the configured polynomial and the solver type, which is not required for all the other mapping types. The information is then used later when instantiating the RBF mappings in xmlTagCallback().
Definition at line 477 of file MappingConfiguration.cpp.
◆ createMapping()
Configures and instantiates all mappings, which do not require a subtag/ a basis function. For the RBF related mappings, this class stores all relevant information, but the class is not instantiated and a nullptr is returned instead. The class instantiation for the RBF related mappings happens in xmlTagCallback() as we need to read the subtag information.
Definition at line 521 of file MappingConfiguration.cpp.
◆ finishRBFConfiguration()
void precice::mapping::MappingConfiguration::finishRBFConfiguration |
( |
| ) |
|
|
private |
◆ mappings()
◆ parseBasisFunctions()
Given a basis function name (as a string), transforms the string into an enum of the BasisFunction.
Definition at line 750 of file MappingConfiguration.cpp.
◆ rbfConfig()
const RBFConfiguration & precice::mapping::MappingConfiguration::rbfConfig |
( |
| ) |
const |
|
inline |
Returns the RBF configuration, which was configured at the latest. Only required for the configuration test
Definition at line 110 of file MappingConfiguration.hpp.
◆ requiresBasisFunction()
bool precice::mapping::MappingConfiguration::requiresBasisFunction |
( |
const std::string & | mappingType | ) |
const |
|
private |
Indicates whether the mapping here requires a basis function/ subtag, given the mapping type (e.g. nearest-neighbor).
Definition at line 745 of file MappingConfiguration.cpp.
◆ resetMappings()
void precice::mapping::MappingConfiguration::resetMappings |
( |
| ) |
|
|
inline |
◆ setExperimental()
void precice::mapping::MappingConfiguration::setExperimental |
( |
bool | experimental | ) |
|
◆ xmlEndTagCallback()
◆ xmlTagCallback()
◆ _executorConfig
◆ _experimental
bool precice::mapping::MappingConfiguration::_experimental = false |
|
private |
◆ _ginkgoParameter
◆ _log
logging::Logger precice::mapping::MappingConfiguration::_log {"config:MappingConfiguration"} |
|
mutableprivate |
◆ _mappings
◆ _meshConfig
◆ _rbfConfig
◆ ATTR_CONSTRAINT
const std::string precice::mapping::MappingConfiguration::ATTR_CONSTRAINT = "constraint" |
|
private |
◆ ATTR_DEVICE_ID
const std::string precice::mapping::MappingConfiguration::ATTR_DEVICE_ID = "gpu-device-id" |
|
private |
◆ ATTR_DIRECTION
const std::string precice::mapping::MappingConfiguration::ATTR_DIRECTION = "direction" |
|
private |
◆ ATTR_FROM
const std::string precice::mapping::MappingConfiguration::ATTR_FROM = "from" |
|
private |
◆ ATTR_GEOMETRIC_MULTISCALE_AXIS
const std::string precice::mapping::MappingConfiguration::ATTR_GEOMETRIC_MULTISCALE_AXIS = "multiscale-axis" |
|
private |
◆ ATTR_GEOMETRIC_MULTISCALE_RADIUS
const std::string precice::mapping::MappingConfiguration::ATTR_GEOMETRIC_MULTISCALE_RADIUS = "multiscale-radius" |
|
private |
◆ ATTR_GEOMETRIC_MULTISCALE_TYPE
const std::string precice::mapping::MappingConfiguration::ATTR_GEOMETRIC_MULTISCALE_TYPE = "multiscale-type" |
|
private |
◆ ATTR_N_THREADS
const std::string precice::mapping::MappingConfiguration::ATTR_N_THREADS = "n-threads" |
|
private |
◆ ATTR_POLYNOMIAL
const std::string precice::mapping::MappingConfiguration::ATTR_POLYNOMIAL = "polynomial" |
|
private |
◆ ATTR_PROJECT_TO_INPUT
const std::string precice::mapping::MappingConfiguration::ATTR_PROJECT_TO_INPUT = "project-to-input" |
|
private |
◆ ATTR_RELATIVE_OVERLAP
const std::string precice::mapping::MappingConfiguration::ATTR_RELATIVE_OVERLAP = "relative-overlap" |
|
private |
◆ ATTR_SHAPE_PARAM
const std::string precice::mapping::MappingConfiguration::ATTR_SHAPE_PARAM = "shape-parameter" |
|
private |
◆ ATTR_SOLVER_RTOL
const std::string precice::mapping::MappingConfiguration::ATTR_SOLVER_RTOL = "solver-rtol" |
|
private |
◆ ATTR_SUPPORT_RADIUS
const std::string precice::mapping::MappingConfiguration::ATTR_SUPPORT_RADIUS = "support-radius" |
|
private |
◆ ATTR_TO
const std::string precice::mapping::MappingConfiguration::ATTR_TO = "to" |
|
private |
◆ ATTR_TYPE
const std::string precice::mapping::MappingConfiguration::ATTR_TYPE = "type" |
|
private |
◆ ATTR_VERTICES_PER_CLUSTER
const std::string precice::mapping::MappingConfiguration::ATTR_VERTICES_PER_CLUSTER = "vertices-per-cluster" |
|
private |
◆ ATTR_X_DEAD
const std::string precice::mapping::MappingConfiguration::ATTR_X_DEAD = "x-dead" |
|
private |
◆ ATTR_Y_DEAD
const std::string precice::mapping::MappingConfiguration::ATTR_Y_DEAD = "y-dead" |
|
private |
◆ ATTR_Z_DEAD
const std::string precice::mapping::MappingConfiguration::ATTR_Z_DEAD = "z-dead" |
|
private |
◆ CONSTRAINT_CONSERVATIVE
const std::string precice::mapping::MappingConfiguration::CONSTRAINT_CONSERVATIVE = "conservative" |
|
private |
◆ CONSTRAINT_CONSISTENT
const std::string precice::mapping::MappingConfiguration::CONSTRAINT_CONSISTENT = "consistent" |
|
private |
◆ CONSTRAINT_SCALED_CONSISTENT_SURFACE
const std::string precice::mapping::MappingConfiguration::CONSTRAINT_SCALED_CONSISTENT_SURFACE = "scaled-consistent-surface" |
|
private |
◆ CONSTRAINT_SCALED_CONSISTENT_VOLUME
const std::string precice::mapping::MappingConfiguration::CONSTRAINT_SCALED_CONSISTENT_VOLUME = "scaled-consistent-volume" |
|
private |
◆ constraintValue
◆ DIRECTION_READ
const std::string precice::mapping::MappingConfiguration::DIRECTION_READ = "read" |
|
private |
◆ DIRECTION_WRITE
const std::string precice::mapping::MappingConfiguration::DIRECTION_WRITE = "write" |
|
private |
◆ EXECUTOR_CPU
const std::string precice::mapping::MappingConfiguration::EXECUTOR_CPU = "cpu" |
|
private |
◆ EXECUTOR_CUDA
const std::string precice::mapping::MappingConfiguration::EXECUTOR_CUDA = "cuda" |
|
private |
◆ EXECUTOR_HIP
const std::string precice::mapping::MappingConfiguration::EXECUTOR_HIP = "hip" |
|
private |
◆ EXECUTOR_OMP
const std::string precice::mapping::MappingConfiguration::EXECUTOR_OMP = "openmp" |
|
private |
◆ GEOMETRIC_MULTISCALE_AXIS_X
const std::string precice::mapping::MappingConfiguration::GEOMETRIC_MULTISCALE_AXIS_X = "x" |
|
private |
◆ GEOMETRIC_MULTISCALE_AXIS_Y
const std::string precice::mapping::MappingConfiguration::GEOMETRIC_MULTISCALE_AXIS_Y = "y" |
|
private |
◆ GEOMETRIC_MULTISCALE_AXIS_Z
const std::string precice::mapping::MappingConfiguration::GEOMETRIC_MULTISCALE_AXIS_Z = "z" |
|
private |
◆ GEOMETRIC_MULTISCALE_TYPE_COLLECT
const std::string precice::mapping::MappingConfiguration::GEOMETRIC_MULTISCALE_TYPE_COLLECT = "collect" |
|
private |
◆ GEOMETRIC_MULTISCALE_TYPE_SPREAD
const std::string precice::mapping::MappingConfiguration::GEOMETRIC_MULTISCALE_TYPE_SPREAD = "spread" |
|
private |
◆ POLYNOMIAL_OFF
const std::string precice::mapping::MappingConfiguration::POLYNOMIAL_OFF = "off" |
|
private |
◆ POLYNOMIAL_ON
const std::string precice::mapping::MappingConfiguration::POLYNOMIAL_ON = "on" |
|
private |
◆ POLYNOMIAL_SEPARATE
const std::string precice::mapping::MappingConfiguration::POLYNOMIAL_SEPARATE = "separate" |
|
private |
◆ RBF_CPOLYNOMIAL_C0
const std::string precice::mapping::MappingConfiguration::RBF_CPOLYNOMIAL_C0 = "compact-polynomial-c0" |
|
private |
◆ RBF_CPOLYNOMIAL_C2
const std::string precice::mapping::MappingConfiguration::RBF_CPOLYNOMIAL_C2 = "compact-polynomial-c2" |
|
private |
◆ RBF_CPOLYNOMIAL_C4
const std::string precice::mapping::MappingConfiguration::RBF_CPOLYNOMIAL_C4 = "compact-polynomial-c4" |
|
private |
◆ RBF_CPOLYNOMIAL_C6
const std::string precice::mapping::MappingConfiguration::RBF_CPOLYNOMIAL_C6 = "compact-polynomial-c6" |
|
private |
◆ RBF_CPOLYNOMIAL_C8
const std::string precice::mapping::MappingConfiguration::RBF_CPOLYNOMIAL_C8 = "compact-polynomial-c8" |
|
private |
◆ RBF_CTPS_C2
const std::string precice::mapping::MappingConfiguration::RBF_CTPS_C2 = "compact-tps-c2" |
|
private |
◆ RBF_GAUSSIAN
const std::string precice::mapping::MappingConfiguration::RBF_GAUSSIAN = "gaussian" |
|
private |
◆ RBF_INV_MULTIQUADRICS
const std::string precice::mapping::MappingConfiguration::RBF_INV_MULTIQUADRICS = "inverse-multiquadrics" |
|
private |
◆ RBF_MULTIQUADRICS
const std::string precice::mapping::MappingConfiguration::RBF_MULTIQUADRICS = "multiquadrics" |
|
private |
◆ RBF_TPS
const std::string precice::mapping::MappingConfiguration::RBF_TPS = "thin-plate-splines" |
|
private |
◆ RBF_VOLUME_SPLINES
const std::string precice::mapping::MappingConfiguration::RBF_VOLUME_SPLINES = "volume-splines" |
|
private |
◆ SUBTAG_BASIS_FUNCTION
const std::string precice::mapping::MappingConfiguration::SUBTAG_BASIS_FUNCTION = "basis-function" |
|
private |
◆ SUBTAG_EXECUTOR
const std::string precice::mapping::MappingConfiguration::SUBTAG_EXECUTOR = "executor" |
|
private |
◆ TAG
const std::string precice::mapping::MappingConfiguration::TAG = "mapping" |
|
private |
◆ TYPE_AXIAL_GEOMETRIC_MULTISCALE
const std::string precice::mapping::MappingConfiguration::TYPE_AXIAL_GEOMETRIC_MULTISCALE = "axial-geometric-multiscale" |
|
private |
◆ TYPE_LINEAR_CELL_INTERPOLATION
const std::string precice::mapping::MappingConfiguration::TYPE_LINEAR_CELL_INTERPOLATION = "linear-cell-interpolation" |
|
private |
◆ TYPE_NEAREST_NEIGHBOR
const std::string precice::mapping::MappingConfiguration::TYPE_NEAREST_NEIGHBOR = "nearest-neighbor" |
|
private |
◆ TYPE_NEAREST_NEIGHBOR_GRADIENT
const std::string precice::mapping::MappingConfiguration::TYPE_NEAREST_NEIGHBOR_GRADIENT = "nearest-neighbor-gradient" |
|
private |
◆ TYPE_NEAREST_PROJECTION
const std::string precice::mapping::MappingConfiguration::TYPE_NEAREST_PROJECTION = "nearest-projection" |
|
private |
◆ TYPE_RADIAL_GEOMETRIC_MULTISCALE
const std::string precice::mapping::MappingConfiguration::TYPE_RADIAL_GEOMETRIC_MULTISCALE = "radial-geometric-multiscale" |
|
private |
◆ TYPE_RBF_ALIAS
const std::string precice::mapping::MappingConfiguration::TYPE_RBF_ALIAS = "rbf" |
|
private |
◆ TYPE_RBF_GLOBAL_DIRECT
const std::string precice::mapping::MappingConfiguration::TYPE_RBF_GLOBAL_DIRECT = "rbf-global-direct" |
|
private |
◆ TYPE_RBF_GLOBAL_ITERATIVE
const std::string precice::mapping::MappingConfiguration::TYPE_RBF_GLOBAL_ITERATIVE = "rbf-global-iterative" |
|
private |
◆ TYPE_RBF_PUM_DIRECT
const std::string precice::mapping::MappingConfiguration::TYPE_RBF_PUM_DIRECT = "rbf-pum-direct" |
|
private |
The documentation for this class was generated from the following files: