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

Base class for interpolation based mappings, where mapping is done using a geometry-based linear combination of input values. Subclasses differ by the way computeMapping() fills the _interpolations and by mesh tagging. Mapping itself is shared. More...

#include <BarycentricBaseMapping.hpp>

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

Public Member Functions

 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.
 
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.
 
virtual void computeMapping ()=0
 Computes the mapping coefficients from the in- and 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.
 
virtual std::string getName () const =0
 Returns the name of the mapping method for logging purpose.
 

Protected Member Functions

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

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.
 

Private Attributes

logging::Logger _log {"mapping::BarycentricBaseMapping"}
 

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...
 

Detailed Description

Base class for interpolation based mappings, where mapping is done using a geometry-based linear combination of input values. Subclasses differ by the way computeMapping() fills the _interpolations and by mesh tagging. Mapping itself is shared.

Definition at line 15 of file BarycentricBaseMapping.hpp.

Constructor & Destructor Documentation

◆ BarycentricBaseMapping()

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

Definition at line 25 of file BarycentricBaseMapping.cpp.

Member Function Documentation

◆ clear()

void precice::mapping::BarycentricBaseMapping::clear ( )
finaloverridevirtual

Removes a computed mapping.

Implements precice::mapping::Mapping.

Definition at line 30 of file BarycentricBaseMapping.cpp.

◆ mapConservative()

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

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 37 of file BarycentricBaseMapping.cpp.

Here is the call graph for this function:

◆ mapConsistent()

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

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 65 of file BarycentricBaseMapping.cpp.

Here is the call graph for this function:

◆ tagMeshFirstRound()

void precice::mapping::BarycentricBaseMapping::tagMeshFirstRound ( )
finaloverridevirtual

Method used by partition. Tags vertices that could be owned by this rank.

Implements precice::mapping::Mapping.

Definition at line 93 of file BarycentricBaseMapping.cpp.

Here is the call graph for this function:

◆ tagMeshSecondRound()

void precice::mapping::BarycentricBaseMapping::tagMeshSecondRound ( )
finaloverridevirtual

Method used by partition. Tags vertices that can be filtered out.

Implements precice::mapping::Mapping.

Definition at line 138 of file BarycentricBaseMapping.cpp.

Member Data Documentation

◆ _interpolations

std::vector<Polation> precice::mapping::BarycentricBaseMapping::_interpolations
protected

Definition at line 35 of file BarycentricBaseMapping.hpp.

◆ _log

logging::Logger precice::mapping::BarycentricBaseMapping::_log {"mapping::BarycentricBaseMapping"}
private

Definition at line 26 of file BarycentricBaseMapping.hpp.


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