Performs XML configuration and holds configured mappings. More...

#include <MappingConfiguration.hpp>

Inheritance diagram for precice::mapping::MappingConfiguration:

Collaboration diagram for precice::mapping::MappingConfiguration:

Classes
struct	ConfiguredMapping
	Configuration data for one mapping. More...
struct	ExecutorConfiguration
struct	GeoMultiscaleConfiguration
struct	GinkgoParameter
struct	RBFConfiguration

Public Types
enum	Direction { WRITE , READ }
	Constants defining the direction of a mapping. More...

Public Member Functions
	MappingConfiguration (xml::XMLTag &parent, mesh::PtrMeshConfiguration meshConfiguration)
void	setExperimental (bool experimental)
void	xmlTagCallback (const xml::ConfigurationContext &context, xml::XMLTag &callingTag) override
	Callback function required for use of automatic configuration.
void	xmlEndTagCallback (const xml::ConfigurationContext &context, xml::XMLTag &callingTag) override
	Callback function required for use of automatic configuration.
const std::vector< ConfiguredMapping > &	mappings ()
	Returns all configured mappings.
const RBFConfiguration &	rbfConfig () const
void	resetMappings ()
Public Member Functions inherited from precice::xml::XMLTag::Listener
Listener &	operator= (Listener &&)=delete
virtual	~Listener ()=default

Private Member Functions
ConfiguredMapping	createMapping (const std::string &direction, const std::string &type, const std::string &fromMeshName, const std::string &toMeshName, const double cgRange, const std::string &geoMultiscaleDimension, const std::string &geoMultiscaleType, const std::string &geoMultiscaleAxis, const double &multiscaleRadius, const std::string &geoMultiscaleProfile, const std::string &geoMultiscaleCrossSection) 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.

Private Attributes
logging::Logger	_log {"config:MappingConfiguration"}
bool	_experimental = false
const std::string	TAG = "mapping"
const std::string	ATTR_TYPE = "type"
const std::string	TYPE_NEAREST_NEIGHBOR = "nearest-neighbor"
const std::string	TYPE_NEAREST_NEIGHBOR_GRADIENT = "nearest-neighbor-gradient"
const std::string	TYPE_NEAREST_PROJECTION = "nearest-projection"
const std::string	TYPE_LINEAR_CELL_INTERPOLATION = "linear-cell-interpolation"
const std::string	TYPE_RBF_GLOBAL_DIRECT = "rbf-global-direct"
const std::string	TYPE_RBF_GLOBAL_ITERATIVE = "rbf-global-iterative"
const std::string	TYPE_RBF_PUM_DIRECT = "rbf-pum-direct"
const std::string	TYPE_RBF_ALIAS = "rbf"
const std::string	TYPE_COARSE_GRAINING = "coarse-graining"
const std::string	TYPE_AXIAL_GEOMETRIC_MULTISCALE = "axial-geometric-multiscale"
const std::string	TYPE_RADIAL_GEOMETRIC_MULTISCALE = "radial-geometric-multiscale"
const std::string	ATTR_DIRECTION = "direction"
const std::string	DIRECTION_WRITE = "write"
const std::string	DIRECTION_READ = "read"
const std::string	ATTR_FROM = "from"
const std::string	ATTR_TO = "to"
const std::string	ATTR_CONSTRAINT = "constraint"
const std::string	CONSTRAINT_CONSISTENT = "consistent"
const std::string	CONSTRAINT_CONSERVATIVE = "conservative"
const std::string	CONSTRAINT_SCALED_CONSISTENT_SURFACE = "scaled-consistent-surface"
const std::string	CONSTRAINT_SCALED_CONSISTENT_VOLUME = "scaled-consistent-volume"
const std::string	ATTR_X_DEAD = "x-dead"
const std::string	ATTR_Y_DEAD = "y-dead"
const std::string	ATTR_Z_DEAD = "z-dead"
const std::string	ATTR_POLYNOMIAL = "polynomial"
const std::string	POLYNOMIAL_SEPARATE = "separate"
const std::string	POLYNOMIAL_ON = "on"
const std::string	POLYNOMIAL_OFF = "off"
const std::string	ATTR_SOLVER_RTOL = "solver-rtol"
const std::string	ATTR_CG_RADIUS = "radius"
const std::string	ATTR_VERTICES_PER_CLUSTER = "vertices-per-cluster"
const std::string	ATTR_RELATIVE_OVERLAP = "relative-overlap"
const std::string	ATTR_PROJECT_TO_INPUT = "project-to-input"
const std::string	SUBTAG_BASIS_FUNCTION = "basis-function"
const std::string	RBF_TPS = "thin-plate-splines"
const std::string	RBF_MULTIQUADRICS = "multiquadrics"
const std::string	RBF_INV_MULTIQUADRICS = "inverse-multiquadrics"
const std::string	RBF_VOLUME_SPLINES = "volume-splines"
const std::string	RBF_GAUSSIAN = "gaussian"
const std::string	RBF_CTPS_C2 = "compact-tps-c2"
const std::string	RBF_CPOLYNOMIAL_C0 = "compact-polynomial-c0"
const std::string	RBF_CPOLYNOMIAL_C2 = "compact-polynomial-c2"
const std::string	RBF_CPOLYNOMIAL_C4 = "compact-polynomial-c4"
const std::string	RBF_CPOLYNOMIAL_C6 = "compact-polynomial-c6"
const std::string	RBF_CPOLYNOMIAL_C8 = "compact-polynomial-c8"
const std::string	ATTR_SHAPE_PARAM = "shape-parameter"
const std::string	ATTR_SUPPORT_RADIUS = "support-radius"
const std::string	ATTR_GEOMETRIC_MULTISCALE_DIMENSION = "multiscale-dimension"
const std::string	ATTR_GEOMETRIC_MULTISCALE_TYPE = "multiscale-type"
const std::string	ATTR_GEOMETRIC_MULTISCALE_AXIS = "multiscale-axis"
const std::string	ATTR_GEOMETRIC_MULTISCALE_RADIUS = "multiscale-radius"
const std::string	ATTR_GEOMETRIC_MULTISCALE_CROSS_SECTION_PROFILE = "multiscale-cross-section-profile"
const std::string	ATTR_GEOMETRIC_MULTISCALE_CROSS_SECTION = "multiscale-cross-section"
const std::string	GEOMETRIC_MULTISCALE_DIMENSION_1D3D = "1d-3d"
const std::string	GEOMETRIC_MULTISCALE_DIMENSION_1D2D = "1d-2d"
const std::string	GEOMETRIC_MULTISCALE_DIMENSION_2D3D = "2d-3d"
const std::string	GEOMETRIC_MULTISCALE_TYPE_SPREAD = "spread"
const std::string	GEOMETRIC_MULTISCALE_TYPE_COLLECT = "collect"
const std::string	GEOMETRIC_MULTISCALE_AXIS_X = "x"
const std::string	GEOMETRIC_MULTISCALE_AXIS_Y = "y"
const std::string	GEOMETRIC_MULTISCALE_AXIS_Z = "z"
const std::string	GEOMETRIC_MULTISCALE_CROSS_SECTION_PROFILE_PARABOLIC = "parabolic"
const std::string	GEOMETRIC_MULTISCALE_CROSS_SECTION_PROFILE_UNIFORM = "uniform"
const std::string	GEOMETRIC_MULTISCALE_CROSS_SECTION_CIRCLE = "circle"
const std::string	GEOMETRIC_MULTISCALE_CROSS_SECTION_SQUARE = "square"
const std::string	SUBTAG_EXECUTOR = "executor"
const std::string	EXECUTOR_CPU = "cpu"
const std::string	EXECUTOR_CUDA = "cuda"
const std::string	EXECUTOR_HIP = "hip"
const std::string	EXECUTOR_SYCL = "sycl"
const std::string	EXECUTOR_OMP = "openmp"
const std::string	ATTR_DEVICE_ID = "gpu-device-id"
const std::string	ATTR_N_THREADS = "n-threads"
const std::string	ATTR_EXECUTION_MODE = "execution-mode"
Mapping::Constraint	constraintValue {}
mesh::PtrMeshConfiguration	_meshConfig
std::vector< ConfiguredMapping >	_mappings
RBFConfiguration	_rbfConfig
std::unique_ptr< ExecutorConfiguration >	_executorConfig
GinkgoParameter	_ginkgoParameter

Detailed Description

Performs XML configuration and holds configured mappings.

Definition at line 16 of file MappingConfiguration.hpp.

Member Enumeration Documentation

◆ Direction

enum precice::mapping::MappingConfiguration::Direction

Constants defining the direction of a mapping.

Enumerator
WRITE
READ

Definition at line 19 of file MappingConfiguration.hpp.

Constructor & Destructor Documentation

◆ MappingConfiguration()

precice::mapping::MappingConfiguration::MappingConfiguration	(	xml::XMLTag &	parent,
		mesh::PtrMeshConfiguration	meshConfiguration )

Definition at line 173 of file MappingConfiguration.cpp.

Here is the call graph for this function:

Member Function Documentation

◆ checkDuplicates()

void precice::mapping::MappingConfiguration::checkDuplicates ( const ConfiguredMapping & mapping )

private

Check whether a mapping to and from the same mesh already exists.

Definition at line 797 of file MappingConfiguration.cpp.

◆ configureRBFMapping()

MappingConfiguration::RBFConfiguration precice::mapping::MappingConfiguration::configureRBFMapping	(	const std::string &	type,
		const std::string &	polynomial,
		bool	xDead,
		bool	yDead,
		bool	zDead,
		double	solverRtol,
		double	verticesPerCluster,
		double	relativeOverlap,
		bool	projectToInput ) const

private

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 566 of file MappingConfiguration.cpp.

Here is the call graph for this function:

◆ createMapping()

MappingConfiguration::ConfiguredMapping precice::mapping::MappingConfiguration::createMapping	(	const std::string &	direction,
		const std::string &	type,
		const std::string &	fromMeshName,
		const std::string &	toMeshName,
		const double	cgRange,
		const std::string &	geoMultiscaleDimension,
		const std::string &	geoMultiscaleType,
		const std::string &	geoMultiscaleAxis,
		const double &	multiscaleRadius,
		const std::string &	geoMultiscaleProfile,
		const std::string &	geoMultiscaleCrossSection ) const

private

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 610 of file MappingConfiguration.cpp.

Here is the call graph for this function:

◆ finishRBFConfiguration()

void precice::mapping::MappingConfiguration::finishRBFConfiguration ( )

private

Definition at line 834 of file MappingConfiguration.cpp.

Here is the call graph for this function:

◆ mappings()

const std::vector< MappingConfiguration::ConfiguredMapping > & precice::mapping::MappingConfiguration::mappings ( )

Returns all configured mappings.

Definition at line 916 of file MappingConfiguration.cpp.

◆ parseBasisFunctions()

BasisFunction precice::mapping::MappingConfiguration::parseBasisFunctions ( const std::string & basisFctName ) const

private

Given a basis function name (as a string), transforms the string into an enum of the BasisFunction.

Definition at line 926 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 111 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 921 of file MappingConfiguration.cpp.

◆ resetMappings()

void precice::mapping::MappingConfiguration::resetMappings ( )

inline

Definition at line 116 of file MappingConfiguration.hpp.

◆ setExperimental()

void precice::mapping::MappingConfiguration::setExperimental ( bool experimental )

Definition at line 406 of file MappingConfiguration.cpp.

◆ xmlEndTagCallback()

void precice::mapping::MappingConfiguration::xmlEndTagCallback	(	const xml::ConfigurationContext &	context,
		xml::XMLTag &	callingTag )

overridevirtual

Callback function required for use of automatic configuration.

Returns: True, if successful.

Implements precice::xml::XMLTag::Listener.

Definition at line 819 of file MappingConfiguration.cpp.

Here is the call graph for this function:

◆ xmlTagCallback()

void precice::mapping::MappingConfiguration::xmlTagCallback	(	const xml::ConfigurationContext &	context,
		xml::XMLTag &	callingTag )

overridevirtual

Callback function required for use of automatic configuration.

Returns: True, if successful.

Implements precice::xml::XMLTag::Listener.

Definition at line 412 of file MappingConfiguration.cpp.

Here is the call graph for this function:

Member Data Documentation

◆ _executorConfig

std::unique_ptr<ExecutorConfiguration> precice::mapping::MappingConfiguration::_executorConfig

private

Definition at line 266 of file MappingConfiguration.hpp.

◆ _experimental

bool precice::mapping::MappingConfiguration::_experimental = false

private

Definition at line 124 of file MappingConfiguration.hpp.

◆ _ginkgoParameter

GinkgoParameter precice::mapping::MappingConfiguration::_ginkgoParameter

private

Definition at line 269 of file MappingConfiguration.hpp.

◆ _log

logging::Logger precice::mapping::MappingConfiguration::_log {"config:MappingConfiguration"}

mutableprivate

Definition at line 122 of file MappingConfiguration.hpp.

◆ _mappings

std::vector<ConfiguredMapping> precice::mapping::MappingConfiguration::_mappings

private

Definition at line 244 of file MappingConfiguration.hpp.

◆ _meshConfig

mesh::PtrMeshConfiguration precice::mapping::MappingConfiguration::_meshConfig

private

Definition at line 241 of file MappingConfiguration.hpp.

◆ _rbfConfig

RBFConfiguration precice::mapping::MappingConfiguration::_rbfConfig

private

Definition at line 249 of file MappingConfiguration.hpp.

◆ ATTR_CG_RADIUS

const std::string precice::mapping::MappingConfiguration::ATTR_CG_RADIUS = "radius"

private

Definition at line 169 of file MappingConfiguration.hpp.

◆ ATTR_CONSTRAINT

const std::string precice::mapping::MappingConfiguration::ATTR_CONSTRAINT = "constraint"

private

Definition at line 149 of file MappingConfiguration.hpp.

◆ ATTR_DEVICE_ID

const std::string precice::mapping::MappingConfiguration::ATTR_DEVICE_ID = "gpu-device-id"

private

Definition at line 227 of file MappingConfiguration.hpp.

◆ ATTR_DIRECTION

const std::string precice::mapping::MappingConfiguration::ATTR_DIRECTION = "direction"

private

Definition at line 142 of file MappingConfiguration.hpp.

◆ ATTR_EXECUTION_MODE

const std::string precice::mapping::MappingConfiguration::ATTR_EXECUTION_MODE = "execution-mode"

private

Definition at line 229 of file MappingConfiguration.hpp.

◆ ATTR_FROM

const std::string precice::mapping::MappingConfiguration::ATTR_FROM = "from"

private

Definition at line 146 of file MappingConfiguration.hpp.

◆ ATTR_GEOMETRIC_MULTISCALE_AXIS

const std::string precice::mapping::MappingConfiguration::ATTR_GEOMETRIC_MULTISCALE_AXIS = "multiscale-axis"

private

Definition at line 202 of file MappingConfiguration.hpp.

◆ ATTR_GEOMETRIC_MULTISCALE_CROSS_SECTION

const std::string precice::mapping::MappingConfiguration::ATTR_GEOMETRIC_MULTISCALE_CROSS_SECTION = "multiscale-cross-section"

private

Definition at line 205 of file MappingConfiguration.hpp.

◆ ATTR_GEOMETRIC_MULTISCALE_CROSS_SECTION_PROFILE

const std::string precice::mapping::MappingConfiguration::ATTR_GEOMETRIC_MULTISCALE_CROSS_SECTION_PROFILE = "multiscale-cross-section-profile"

private

Definition at line 204 of file MappingConfiguration.hpp.

◆ ATTR_GEOMETRIC_MULTISCALE_DIMENSION

const std::string precice::mapping::MappingConfiguration::ATTR_GEOMETRIC_MULTISCALE_DIMENSION = "multiscale-dimension"

private

Definition at line 200 of file MappingConfiguration.hpp.

◆ ATTR_GEOMETRIC_MULTISCALE_RADIUS

const std::string precice::mapping::MappingConfiguration::ATTR_GEOMETRIC_MULTISCALE_RADIUS = "multiscale-radius"

private

Definition at line 203 of file MappingConfiguration.hpp.

◆ ATTR_GEOMETRIC_MULTISCALE_TYPE

const std::string precice::mapping::MappingConfiguration::ATTR_GEOMETRIC_MULTISCALE_TYPE = "multiscale-type"

private

Definition at line 201 of file MappingConfiguration.hpp.

◆ ATTR_N_THREADS

const std::string precice::mapping::MappingConfiguration::ATTR_N_THREADS = "n-threads"

private

Definition at line 228 of file MappingConfiguration.hpp.

◆ ATTR_POLYNOMIAL

const std::string precice::mapping::MappingConfiguration::ATTR_POLYNOMIAL = "polynomial"

private

Definition at line 160 of file MappingConfiguration.hpp.

◆ ATTR_PROJECT_TO_INPUT

const std::string precice::mapping::MappingConfiguration::ATTR_PROJECT_TO_INPUT = "project-to-input"

private

Definition at line 179 of file MappingConfiguration.hpp.

◆ ATTR_RELATIVE_OVERLAP

const std::string precice::mapping::MappingConfiguration::ATTR_RELATIVE_OVERLAP = "relative-overlap"

private

Definition at line 178 of file MappingConfiguration.hpp.

◆ ATTR_SHAPE_PARAM

const std::string precice::mapping::MappingConfiguration::ATTR_SHAPE_PARAM = "shape-parameter"

private

Definition at line 196 of file MappingConfiguration.hpp.

◆ ATTR_SOLVER_RTOL

const std::string precice::mapping::MappingConfiguration::ATTR_SOLVER_RTOL = "solver-rtol"

private

Definition at line 166 of file MappingConfiguration.hpp.

◆ ATTR_SUPPORT_RADIUS

const std::string precice::mapping::MappingConfiguration::ATTR_SUPPORT_RADIUS = "support-radius"

private

Definition at line 197 of file MappingConfiguration.hpp.

◆ ATTR_TO

const std::string precice::mapping::MappingConfiguration::ATTR_TO = "to"

private

Definition at line 147 of file MappingConfiguration.hpp.

◆ ATTR_TYPE

const std::string precice::mapping::MappingConfiguration::ATTR_TYPE = "type"

private

Definition at line 129 of file MappingConfiguration.hpp.

◆ ATTR_VERTICES_PER_CLUSTER

const std::string precice::mapping::MappingConfiguration::ATTR_VERTICES_PER_CLUSTER = "vertices-per-cluster"

private

Definition at line 177 of file MappingConfiguration.hpp.

◆ ATTR_X_DEAD

const std::string precice::mapping::MappingConfiguration::ATTR_X_DEAD = "x-dead"

private

Definition at line 156 of file MappingConfiguration.hpp.

◆ ATTR_Y_DEAD

const std::string precice::mapping::MappingConfiguration::ATTR_Y_DEAD = "y-dead"

private

Definition at line 157 of file MappingConfiguration.hpp.

◆ ATTR_Z_DEAD

const std::string precice::mapping::MappingConfiguration::ATTR_Z_DEAD = "z-dead"

private

Definition at line 158 of file MappingConfiguration.hpp.

◆ CONSTRAINT_CONSERVATIVE

const std::string precice::mapping::MappingConfiguration::CONSTRAINT_CONSERVATIVE = "conservative"

private

Definition at line 151 of file MappingConfiguration.hpp.

◆ CONSTRAINT_CONSISTENT

const std::string precice::mapping::MappingConfiguration::CONSTRAINT_CONSISTENT = "consistent"

private

Definition at line 150 of file MappingConfiguration.hpp.

◆ CONSTRAINT_SCALED_CONSISTENT_SURFACE

const std::string precice::mapping::MappingConfiguration::CONSTRAINT_SCALED_CONSISTENT_SURFACE = "scaled-consistent-surface"

private

Definition at line 152 of file MappingConfiguration.hpp.

◆ CONSTRAINT_SCALED_CONSISTENT_VOLUME

const std::string precice::mapping::MappingConfiguration::CONSTRAINT_SCALED_CONSISTENT_VOLUME = "scaled-consistent-volume"

private

Definition at line 153 of file MappingConfiguration.hpp.

◆ constraintValue

Mapping::Constraint precice::mapping::MappingConfiguration::constraintValue {}

private

Definition at line 239 of file MappingConfiguration.hpp.

◆ DIRECTION_READ

const std::string precice::mapping::MappingConfiguration::DIRECTION_READ = "read"

private

Definition at line 144 of file MappingConfiguration.hpp.

◆ DIRECTION_WRITE

const std::string precice::mapping::MappingConfiguration::DIRECTION_WRITE = "write"

private

Definition at line 143 of file MappingConfiguration.hpp.

◆ EXECUTOR_CPU

const std::string precice::mapping::MappingConfiguration::EXECUTOR_CPU = "cpu"

private

Definition at line 221 of file MappingConfiguration.hpp.

◆ EXECUTOR_CUDA

const std::string precice::mapping::MappingConfiguration::EXECUTOR_CUDA = "cuda"

private

Definition at line 222 of file MappingConfiguration.hpp.

◆ EXECUTOR_HIP

const std::string precice::mapping::MappingConfiguration::EXECUTOR_HIP = "hip"

private

Definition at line 223 of file MappingConfiguration.hpp.

◆ EXECUTOR_OMP

const std::string precice::mapping::MappingConfiguration::EXECUTOR_OMP = "openmp"

private

Definition at line 225 of file MappingConfiguration.hpp.

◆ EXECUTOR_SYCL

const std::string precice::mapping::MappingConfiguration::EXECUTOR_SYCL = "sycl"

private

Definition at line 224 of file MappingConfiguration.hpp.

◆ GEOMETRIC_MULTISCALE_AXIS_X

const std::string precice::mapping::MappingConfiguration::GEOMETRIC_MULTISCALE_AXIS_X = "x"

private

Definition at line 211 of file MappingConfiguration.hpp.

◆ GEOMETRIC_MULTISCALE_AXIS_Y

const std::string precice::mapping::MappingConfiguration::GEOMETRIC_MULTISCALE_AXIS_Y = "y"

private

Definition at line 212 of file MappingConfiguration.hpp.

◆ GEOMETRIC_MULTISCALE_AXIS_Z

const std::string precice::mapping::MappingConfiguration::GEOMETRIC_MULTISCALE_AXIS_Z = "z"

private

Definition at line 213 of file MappingConfiguration.hpp.

◆ GEOMETRIC_MULTISCALE_CROSS_SECTION_CIRCLE

const std::string precice::mapping::MappingConfiguration::GEOMETRIC_MULTISCALE_CROSS_SECTION_CIRCLE = "circle"

private

Definition at line 216 of file MappingConfiguration.hpp.

◆ GEOMETRIC_MULTISCALE_CROSS_SECTION_PROFILE_PARABOLIC

const std::string precice::mapping::MappingConfiguration::GEOMETRIC_MULTISCALE_CROSS_SECTION_PROFILE_PARABOLIC = "parabolic"

private

Definition at line 214 of file MappingConfiguration.hpp.

◆ GEOMETRIC_MULTISCALE_CROSS_SECTION_PROFILE_UNIFORM

const std::string precice::mapping::MappingConfiguration::GEOMETRIC_MULTISCALE_CROSS_SECTION_PROFILE_UNIFORM = "uniform"

private

Definition at line 215 of file MappingConfiguration.hpp.

◆ GEOMETRIC_MULTISCALE_CROSS_SECTION_SQUARE

const std::string precice::mapping::MappingConfiguration::GEOMETRIC_MULTISCALE_CROSS_SECTION_SQUARE = "square"

private

Definition at line 217 of file MappingConfiguration.hpp.

◆ GEOMETRIC_MULTISCALE_DIMENSION_1D2D

const std::string precice::mapping::MappingConfiguration::GEOMETRIC_MULTISCALE_DIMENSION_1D2D = "1d-2d"

private

Definition at line 207 of file MappingConfiguration.hpp.

◆ GEOMETRIC_MULTISCALE_DIMENSION_1D3D

const std::string precice::mapping::MappingConfiguration::GEOMETRIC_MULTISCALE_DIMENSION_1D3D = "1d-3d"

private

Definition at line 206 of file MappingConfiguration.hpp.

◆ GEOMETRIC_MULTISCALE_DIMENSION_2D3D

const std::string precice::mapping::MappingConfiguration::GEOMETRIC_MULTISCALE_DIMENSION_2D3D = "2d-3d"

private

Definition at line 208 of file MappingConfiguration.hpp.

◆ GEOMETRIC_MULTISCALE_TYPE_COLLECT

const std::string precice::mapping::MappingConfiguration::GEOMETRIC_MULTISCALE_TYPE_COLLECT = "collect"

private

Definition at line 210 of file MappingConfiguration.hpp.

◆ GEOMETRIC_MULTISCALE_TYPE_SPREAD

const std::string precice::mapping::MappingConfiguration::GEOMETRIC_MULTISCALE_TYPE_SPREAD = "spread"

private

Definition at line 209 of file MappingConfiguration.hpp.

◆ POLYNOMIAL_OFF

const std::string precice::mapping::MappingConfiguration::POLYNOMIAL_OFF = "off"

private

Definition at line 163 of file MappingConfiguration.hpp.

◆ POLYNOMIAL_ON

const std::string precice::mapping::MappingConfiguration::POLYNOMIAL_ON = "on"

private

Definition at line 162 of file MappingConfiguration.hpp.

◆ POLYNOMIAL_SEPARATE

const std::string precice::mapping::MappingConfiguration::POLYNOMIAL_SEPARATE = "separate"

private

Definition at line 161 of file MappingConfiguration.hpp.

◆ RBF_CPOLYNOMIAL_C0

const std::string precice::mapping::MappingConfiguration::RBF_CPOLYNOMIAL_C0 = "compact-polynomial-c0"

private

Definition at line 189 of file MappingConfiguration.hpp.

◆ RBF_CPOLYNOMIAL_C2

const std::string precice::mapping::MappingConfiguration::RBF_CPOLYNOMIAL_C2 = "compact-polynomial-c2"

private

Definition at line 190 of file MappingConfiguration.hpp.

◆ RBF_CPOLYNOMIAL_C4

const std::string precice::mapping::MappingConfiguration::RBF_CPOLYNOMIAL_C4 = "compact-polynomial-c4"

private

Definition at line 191 of file MappingConfiguration.hpp.

◆ RBF_CPOLYNOMIAL_C6

const std::string precice::mapping::MappingConfiguration::RBF_CPOLYNOMIAL_C6 = "compact-polynomial-c6"

private

Definition at line 192 of file MappingConfiguration.hpp.

◆ RBF_CPOLYNOMIAL_C8

const std::string precice::mapping::MappingConfiguration::RBF_CPOLYNOMIAL_C8 = "compact-polynomial-c8"

private

Definition at line 193 of file MappingConfiguration.hpp.

◆ RBF_CTPS_C2

const std::string precice::mapping::MappingConfiguration::RBF_CTPS_C2 = "compact-tps-c2"

private

Definition at line 188 of file MappingConfiguration.hpp.

◆ RBF_GAUSSIAN

const std::string precice::mapping::MappingConfiguration::RBF_GAUSSIAN = "gaussian"

private

Definition at line 187 of file MappingConfiguration.hpp.

◆ RBF_INV_MULTIQUADRICS

const std::string precice::mapping::MappingConfiguration::RBF_INV_MULTIQUADRICS = "inverse-multiquadrics"

private

Definition at line 185 of file MappingConfiguration.hpp.

◆ RBF_MULTIQUADRICS

const std::string precice::mapping::MappingConfiguration::RBF_MULTIQUADRICS = "multiquadrics"

private

Definition at line 184 of file MappingConfiguration.hpp.

◆ RBF_TPS

const std::string precice::mapping::MappingConfiguration::RBF_TPS = "thin-plate-splines"

private

Definition at line 183 of file MappingConfiguration.hpp.

◆ RBF_VOLUME_SPLINES

const std::string precice::mapping::MappingConfiguration::RBF_VOLUME_SPLINES = "volume-splines"

private

Definition at line 186 of file MappingConfiguration.hpp.

◆ SUBTAG_BASIS_FUNCTION

const std::string precice::mapping::MappingConfiguration::SUBTAG_BASIS_FUNCTION = "basis-function"

private

Definition at line 182 of file MappingConfiguration.hpp.

◆ SUBTAG_EXECUTOR

const std::string precice::mapping::MappingConfiguration::SUBTAG_EXECUTOR = "executor"

private

Definition at line 220 of file MappingConfiguration.hpp.

◆ TAG

const std::string precice::mapping::MappingConfiguration::TAG = "mapping"

private

Definition at line 126 of file MappingConfiguration.hpp.

◆ TYPE_AXIAL_GEOMETRIC_MULTISCALE

const std::string precice::mapping::MappingConfiguration::TYPE_AXIAL_GEOMETRIC_MULTISCALE = "axial-geometric-multiscale"

private

Definition at line 139 of file MappingConfiguration.hpp.

◆ TYPE_COARSE_GRAINING

const std::string precice::mapping::MappingConfiguration::TYPE_COARSE_GRAINING = "coarse-graining"

private

Definition at line 138 of file MappingConfiguration.hpp.

◆ TYPE_LINEAR_CELL_INTERPOLATION

const std::string precice::mapping::MappingConfiguration::TYPE_LINEAR_CELL_INTERPOLATION = "linear-cell-interpolation"

private

Definition at line 133 of file MappingConfiguration.hpp.

◆ TYPE_NEAREST_NEIGHBOR

const std::string precice::mapping::MappingConfiguration::TYPE_NEAREST_NEIGHBOR = "nearest-neighbor"

private

Definition at line 130 of file MappingConfiguration.hpp.

◆ TYPE_NEAREST_NEIGHBOR_GRADIENT

const std::string precice::mapping::MappingConfiguration::TYPE_NEAREST_NEIGHBOR_GRADIENT = "nearest-neighbor-gradient"

private

Definition at line 131 of file MappingConfiguration.hpp.

◆ TYPE_NEAREST_PROJECTION

const std::string precice::mapping::MappingConfiguration::TYPE_NEAREST_PROJECTION = "nearest-projection"

private

Definition at line 132 of file MappingConfiguration.hpp.

◆ TYPE_RADIAL_GEOMETRIC_MULTISCALE

const std::string precice::mapping::MappingConfiguration::TYPE_RADIAL_GEOMETRIC_MULTISCALE = "radial-geometric-multiscale"

private

Definition at line 140 of file MappingConfiguration.hpp.

◆ TYPE_RBF_ALIAS

const std::string precice::mapping::MappingConfiguration::TYPE_RBF_ALIAS = "rbf"

private

Definition at line 137 of file MappingConfiguration.hpp.

◆ TYPE_RBF_GLOBAL_DIRECT

const std::string precice::mapping::MappingConfiguration::TYPE_RBF_GLOBAL_DIRECT = "rbf-global-direct"

private

Definition at line 134 of file MappingConfiguration.hpp.

◆ TYPE_RBF_GLOBAL_ITERATIVE

const std::string precice::mapping::MappingConfiguration::TYPE_RBF_GLOBAL_ITERATIVE = "rbf-global-iterative"

private

Definition at line 135 of file MappingConfiguration.hpp.

◆ TYPE_RBF_PUM_DIRECT

const std::string precice::mapping::MappingConfiguration::TYPE_RBF_PUM_DIRECT = "rbf-pum-direct"

private

Definition at line 136 of file MappingConfiguration.hpp.

The documentation for this class was generated from the following files:

src/mapping/config/MappingConfiguration.hpp
src/mapping/config/MappingConfiguration.cpp

Classes

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ Direction

Constructor & Destructor Documentation

◆ MappingConfiguration()

Member Function Documentation

◆ checkDuplicates()

◆ configureRBFMapping()

◆ createMapping()

◆ finishRBFConfiguration()

◆ mappings()

◆ parseBasisFunctions()

◆ rbfConfig()

◆ requiresBasisFunction()

◆ resetMappings()

◆ setExperimental()

◆ xmlEndTagCallback()

◆ xmlTagCallback()

Member Data Documentation

◆ _executorConfig

◆ _experimental

◆ _ginkgoParameter

◆ _log

◆ _mappings

◆ _meshConfig

◆ _rbfConfig

◆ ATTR_CG_RADIUS

◆ ATTR_CONSTRAINT

◆ ATTR_DEVICE_ID

◆ ATTR_DIRECTION

◆ ATTR_EXECUTION_MODE

◆ ATTR_FROM

◆ ATTR_GEOMETRIC_MULTISCALE_AXIS

◆ ATTR_GEOMETRIC_MULTISCALE_CROSS_SECTION

◆ ATTR_GEOMETRIC_MULTISCALE_CROSS_SECTION_PROFILE

◆ ATTR_GEOMETRIC_MULTISCALE_DIMENSION

◆ ATTR_GEOMETRIC_MULTISCALE_RADIUS

◆ ATTR_GEOMETRIC_MULTISCALE_TYPE

◆ ATTR_N_THREADS

◆ ATTR_POLYNOMIAL

◆ ATTR_PROJECT_TO_INPUT

◆ ATTR_RELATIVE_OVERLAP

◆ ATTR_SHAPE_PARAM

◆ ATTR_SOLVER_RTOL

◆ ATTR_SUPPORT_RADIUS

◆ ATTR_TO

◆ ATTR_TYPE

◆ ATTR_VERTICES_PER_CLUSTER

◆ ATTR_X_DEAD

◆ ATTR_Y_DEAD

◆ ATTR_Z_DEAD

◆ CONSTRAINT_CONSERVATIVE

◆ CONSTRAINT_CONSISTENT

◆ CONSTRAINT_SCALED_CONSISTENT_SURFACE

◆ CONSTRAINT_SCALED_CONSISTENT_VOLUME

◆ constraintValue

◆ DIRECTION_READ

◆ DIRECTION_WRITE

◆ EXECUTOR_CPU

◆ EXECUTOR_CUDA

◆ EXECUTOR_HIP

◆ EXECUTOR_OMP

◆ EXECUTOR_SYCL

◆ GEOMETRIC_MULTISCALE_AXIS_X

◆ GEOMETRIC_MULTISCALE_AXIS_Y

◆ GEOMETRIC_MULTISCALE_AXIS_Z

◆ GEOMETRIC_MULTISCALE_CROSS_SECTION_CIRCLE

◆ GEOMETRIC_MULTISCALE_CROSS_SECTION_PROFILE_PARABOLIC

◆ GEOMETRIC_MULTISCALE_CROSS_SECTION_PROFILE_UNIFORM

◆ GEOMETRIC_MULTISCALE_CROSS_SECTION_SQUARE

◆ GEOMETRIC_MULTISCALE_DIMENSION_1D2D

◆ GEOMETRIC_MULTISCALE_DIMENSION_1D3D

◆ GEOMETRIC_MULTISCALE_DIMENSION_2D3D

◆ GEOMETRIC_MULTISCALE_TYPE_COLLECT

◆ GEOMETRIC_MULTISCALE_TYPE_SPREAD