preCICE v3.1.2
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | List of all members
precice::mapping::NearestNeighborMapping Class Reference

Mapping using nearest neighboring vertices. More...

#include <NearestNeighborMapping.hpp>

Inheritance diagram for precice::mapping::NearestNeighborMapping:
[legend]
Collaboration diagram for precice::mapping::NearestNeighborMapping:
[legend]

Public Member Functions

 NearestNeighborMapping (Constraint constraint, int dimensions)
 Constructor.
 
std::string getName () const final override
 name of the nn mapping
 
- Public Member Functions inherited from precice::mapping::NearestNeighborBaseMapping
 NearestNeighborBaseMapping (Constraint constraint, int dimensions, bool hasGradient, std::string mappingName, std::string mappingNameShort)
 Constructor.
 
void computeMapping () final override
 Computes the mapping coefficients from the in- and output mesh.
 
void clear () final override
 Removes a computed mapping.
 
virtual void onMappingComputed (mesh::PtrMesh origins, mesh::PtrMesh searchSpace)
 
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.
 
Mappingoperator= (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::PtrMeshgetInputMesh () const
 
const mesh::PtrMeshgetOutputMesh () 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.
 

Protected Member Functions

void mapConservative (const time::Sample &inData, Eigen::VectorXd &outData) final override
 Maps data using a conservative constraint.
 
void mapConsistent (const time::Sample &inData, Eigen::VectorXd &outData) final 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
 

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 Attributes inherited from precice::mapping::NearestNeighborBaseMapping
std::string mappingName
 NearestNeighborMapping or NearestNeighborGradientMapping.
 
std::string mappingNameShort
 nn or nng
 
logging::Logger _log {"mapping::" + mappingName}
 
std::vector< Eigen::VectorXd > _offsetsMatched
 
std::vector< int > _vertexIndices
 Computed output vertex indices to map data from input vertices to.
 
- 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.
 

Detailed Description

Mapping using nearest neighboring vertices.

Definition at line 12 of file NearestNeighborMapping.hpp.

Constructor & Destructor Documentation

◆ NearestNeighborMapping()

precice::mapping::NearestNeighborMapping::NearestNeighborMapping ( Constraint constraint,
int dimensions )

Constructor.

Parameters
[in]constraintSpecifies mapping to be consistent or conservative.
[in]dimensionsDimensionality of the meshes

Definition at line 15 of file NearestNeighborMapping.cpp.

Here is the call graph for this function:

Member Function Documentation

◆ getName()

std::string precice::mapping::NearestNeighborMapping::getName ( ) const
finaloverridevirtual

name of the nn mapping

Implements precice::mapping::Mapping.

Definition at line 83 of file NearestNeighborMapping.cpp.

◆ mapConservative()

void precice::mapping::NearestNeighborMapping::mapConservative ( const time::Sample & inData,
Eigen::VectorXd & outData )
finaloverrideprotectedvirtual

Maps data using a conservative constraint.

Parameters
[in]inputSample to map data from
[in]outputValues to map to

If requiresInitialGuess(), then the initial guess is available via initialGuess(). Provide a new initial guess by overwriting it. The mapping has full control over its size.

See also
For mappings requiring an initialGuess: initialGuess() hasInitialGuess()

Implements precice::mapping::Mapping.

Definition at line 29 of file NearestNeighborMapping.cpp.

Here is the call graph for this function:

◆ mapConsistent()

void precice::mapping::NearestNeighborMapping::mapConsistent ( const time::Sample & inData,
Eigen::VectorXd & outData )
finaloverrideprotectedvirtual

Maps data using a consistent constraint.

Parameters
[in]inputSample to map data from
[in]outputValues to map to

If requiresInitialGuess(), then the initial guess is available via initialGuess(). Provide a new initial guess by overwriting it. The mapping has full control over its size.

See also
For mappings requiring an initialGuess: initialGuess() hasInitialGuess()

Implements precice::mapping::Mapping.

Definition at line 56 of file NearestNeighborMapping.cpp.

Here is the call graph for this function:

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