Mapping using orthogonal projection to nearest triangle/edge/vertex and linear interpolation from projected point. More...

#include <NearestProjectionMapping.hpp>

Inheritance diagram for precice::mapping::NearestProjectionMapping:

[legend]

Collaboration diagram for precice::mapping::NearestProjectionMapping:

[legend]

Public Member Functions
	NearestProjectionMapping (Constraint constraint, int dimensions)
	Constructor, taking mapping constraint.

void	computeMapping () final override
	Computes the projections and interpolation relations.

std::string	getName () const final override
	name of the np mapping

Public Member Functions inherited from precice::mapping::BarycentricBaseMapping
	BarycentricBaseMapping (Constraint constraint, int dimensions)

void	clear () final override
	Removes a computed mapping.

void	tagMeshFirstRound () final override
	Method used by partition. Tags vertices that could be owned by this rank.

void	tagMeshSecondRound () final override
	Method used by partition. Tags vertices that can be filtered out.

Public Member Functions inherited from precice::mapping::Mapping
	Mapping (Constraint constraint, int dimensions, bool requiresGradientData, InitialGuessRequirement initialGuessRequirement)
	Constructor, takes mapping constraint.

Mapping &	operator= (Mapping &&)=delete

virtual	~Mapping ()=default
	Destructor, empty.

void	setMeshes (const mesh::PtrMesh &input, const mesh::PtrMesh &output)
	Sets input and output meshes carrying data to be mapped.

const mesh::PtrMesh &	getInputMesh () const

const mesh::PtrMesh &	getOutputMesh () const

Constraint	getConstraint () const
	Returns the constraint (consistent/conservative) of the mapping.

MeshRequirement	getInputRequirement () const
	Returns the requirement on the input mesh.

MeshRequirement	getOutputRequirement () const
	Returns the requirement on the output mesh.

bool	hasComputedMapping () const
	Returns true, if the mapping has been computed.

virtual bool	hasConstraint (const Constraint &constraint) const
	Checks whether the mapping has the given constraint or not.

bool	isScaledConsistent () const
	Returns true if mapping is a form of scaled consistent mapping.

bool	requiresInitialGuess () const
	Return true if the mapping requires an initial guess.

const Eigen::VectorXd &	initialGuess () const
	Return the provided initial guess of a mapping using an initialGuess.

Eigen::VectorXd &	initialGuess ()

bool	hasInitialGuess () const
	True if initialGuess().size() == 0.

void	map (int inputDataID, int outputDataID)

void	map (int inputDataID, int outputDataID, Eigen::VectorXd &initialGuess)

void	map (const time::Sample &input, Eigen::VectorXd &output)
	Maps an input Sample to output data from input mesh to output mesh.

void	map (const time::Sample &input, Eigen::VectorXd &output, Eigen::VectorXd &initialGuess)
	Maps an input Sample to output data from input mesh to output mesh, given an initialGuess.

virtual void	scaleConsistentMapping (const Eigen::VectorXd &input, Eigen::VectorXd &output, Constraint type) const
	Scales the consistently mapped output data such that the surface integral of the values on input mesh and output mesh are equal.

bool	requiresGradientData () const
	Returns whether the mapping requires gradient data.

Private Attributes
logging::Logger	_log {"mapping::NearestNeighborProjectionMapping"}

Additional Inherited Members
Public Types inherited from precice::mapping::Mapping
enum	Constraint { CONSISTENT , CONSERVATIVE , SCALED_CONSISTENT_SURFACE , SCALED_CONSISTENT_VOLUME }
	Specifies additional constraints for a mapping. More...

enum class	MeshRequirement { UNDEFINED = 0 , VERTEX = 1 , FULL = 2 }
	Specifies requirements for the input and output meshes of a mapping. More...

enum class	InitialGuessRequirement : bool { Required = true , None = false }
	Specifies whether the mapping requires an initial guess. More...

Protected Member Functions inherited from precice::mapping::BarycentricBaseMapping
void	mapConservative (const time::Sample &inData, Eigen::VectorXd &outData) override
	Maps data using a conservative constraint.

void	mapConsistent (const time::Sample &inData, Eigen::VectorXd &outData) override
	Maps data using a consistent constraint.

Protected Member Functions inherited from precice::mapping::Mapping
mesh::PtrMesh	input () const
	Returns pointer to input mesh.

mesh::PtrMesh	output () const
	Returns pointer to output mesh.

void	setInputRequirement (MeshRequirement requirement)
	Sets the mesh requirement for the input mesh.

void	setOutputRequirement (MeshRequirement requirement)
	Sets the mesh requirement for the output mesh.

int	getDimensions () const

Protected Attributes inherited from precice::mapping::BarycentricBaseMapping
std::vector< Polation >	_interpolations

Protected Attributes inherited from precice::mapping::Mapping
bool	_hasComputedMapping = false
	Flag to indicate whether computeMapping() has been called.

bool	_requiresGradientData
	Flag if gradient data is required for the mapping.