preCICE v3.1.2
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Private Member Functions | Private Attributes | List of all members
precice::mapping::RadialBasisFctMapping< SOLVER_T, Args > Class Template Reference

Mapping with radial basis functions. More...

#include <RadialBasisFctMapping.hpp>

Inheritance diagram for precice::mapping::RadialBasisFctMapping< SOLVER_T, Args >:
[legend]
Collaboration diagram for precice::mapping::RadialBasisFctMapping< SOLVER_T, Args >:
[legend]

Public Types

using RADIAL_BASIS_FUNCTION_T = typename SOLVER_T::BASIS_FUNCTION_T
 
- 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...
 

Public Member Functions

 RadialBasisFctMapping (Mapping::Constraint constraint, int dimensions, RADIAL_BASIS_FUNCTION_T function, std::array< bool, 3 > deadAxis, Polynomial polynomial, Args... args)
 Constructor.
 
void computeMapping () final override
 Computes the mapping coefficients from the in- and output mesh.
 
void clear () final override
 Removes a computed mapping.
 
std::string getName () const final override
 name of the rbf mapping
 
- Public Member Functions inherited from precice::mapping::RadialBasisFctBaseMapping< SOLVER_T::BASIS_FUNCTION_T >
 RadialBasisFctBaseMapping (Constraint constraint, int dimensions, const SOLVER_T::BASIS_FUNCTION_T &function, std::array< bool, 3 > deadAxis, InitialGuessRequirement mappingType)
 Constructor.
 
virtual ~RadialBasisFctBaseMapping ()=default
 
virtual void tagMeshFirstRound () final
 Method used by partition. Tags vertices that could be owned by this rank.
 
virtual void tagMeshSecondRound () final
 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.
 

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

Private Attributes

precice::logging::Logger _log {"mapping::RadialBasisFctMapping"}
 
std::unique_ptr< SOLVER_T > _rbfSolver
 
Polynomial _polynomial
 Treatment of the polynomial.
 
std::tuple< Args... > optionalArgs
 Optional constructor arguments for the solver class.
 

Additional Inherited Members

- Protected Member Functions inherited from precice::mapping::RadialBasisFctBaseMapping< SOLVER_T::BASIS_FUNCTION_T >
int getPolynomialParameters () const
 Computes the number of polynomial degrees of freedom based on the problem dimension and the dead axis.
 
- 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::RadialBasisFctBaseMapping< SOLVER_T::BASIS_FUNCTION_T >
SOLVER_T::BASIS_FUNCTION_T _basisFunction
 Radial basis function type used in interpolation.
 
std::vector< bool > _deadAxis
 true if the mapping along some axis should be ignored
 
- 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

template<typename SOLVER_T, typename... Args>
class precice::mapping::RadialBasisFctMapping< SOLVER_T, Args >

Mapping with radial basis functions.

With help of the input data points and values an interpolant is constructed. The interpolant is formed by a weighted sum of conditionally positive radial basis functions and a (low order) polynomial, and evaluated at the output data points.

The radial basis function type has to be given as template parameter, and has to be one of the defined types in this file.

Definition at line 30 of file RadialBasisFctMapping.hpp.

Member Typedef Documentation

◆ RADIAL_BASIS_FUNCTION_T

template<typename SOLVER_T , typename... Args>
using precice::mapping::RadialBasisFctMapping< SOLVER_T, Args >::RADIAL_BASIS_FUNCTION_T = typename SOLVER_T::BASIS_FUNCTION_T

Definition at line 32 of file RadialBasisFctMapping.hpp.

Constructor & Destructor Documentation

◆ RadialBasisFctMapping()

template<typename SOLVER_T , typename... Args>
precice::mapping::RadialBasisFctMapping< SOLVER_T, Args >::RadialBasisFctMapping ( Mapping::Constraint constraint,
int dimensions,
RADIAL_BASIS_FUNCTION_T function,
std::array< bool, 3 > deadAxis,
Polynomial polynomial,
Args... args )

Constructor.

Parameters
[in]constraintSpecifies mapping to be consistent or conservative.
[in]dimensionsDimensionality of the meshes
[in]functionRadial basis function used for mapping.
[in]xDead,yDead,zDeadDeactivates mapping along an axis

Definition at line 80 of file RadialBasisFctMapping.hpp.

Member Function Documentation

◆ clear()

template<typename SOLVER_T , typename... Args>
void precice::mapping::RadialBasisFctMapping< SOLVER_T, Args >::clear ( )
finaloverridevirtual

Removes a computed mapping.

Implements precice::mapping::RadialBasisFctBaseMapping< SOLVER_T::BASIS_FUNCTION_T >.

Definition at line 171 of file RadialBasisFctMapping.hpp.

◆ computeMapping()

template<typename SOLVER_T , typename... Args>
void precice::mapping::RadialBasisFctMapping< SOLVER_T, Args >::computeMapping ( )
finaloverridevirtual

Computes the mapping coefficients from the in- and output mesh.

Implements precice::mapping::RadialBasisFctBaseMapping< SOLVER_T::BASIS_FUNCTION_T >.

Definition at line 95 of file RadialBasisFctMapping.hpp.

Here is the call graph for this function:

◆ getName()

template<typename SOLVER_T , typename... Args>
std::string precice::mapping::RadialBasisFctMapping< SOLVER_T, Args >::getName ( ) const
finaloverridevirtual

name of the rbf mapping

Implements precice::mapping::Mapping.

Definition at line 179 of file RadialBasisFctMapping.hpp.

◆ mapConservative()

template<typename SOLVER_T , typename... Args>
void precice::mapping::RadialBasisFctMapping< SOLVER_T, Args >::mapConservative ( const time::Sample & inData,
Eigen::VectorXd & outData )
finaloverrideprivatevirtual

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 195 of file RadialBasisFctMapping.hpp.

Here is the call graph for this function:

◆ mapConsistent()

template<typename SOLVER_T , typename... Args>
void precice::mapping::RadialBasisFctMapping< SOLVER_T, Args >::mapConsistent ( const time::Sample & inData,
Eigen::VectorXd & outData )
finaloverrideprivatevirtual

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 319 of file RadialBasisFctMapping.hpp.

Here is the call graph for this function:

Member Data Documentation

◆ _log

template<typename SOLVER_T , typename... Args>
precice::logging::Logger precice::mapping::RadialBasisFctMapping< SOLVER_T, Args >::_log {"mapping::RadialBasisFctMapping"}
private

Definition at line 59 of file RadialBasisFctMapping.hpp.

◆ _polynomial

template<typename SOLVER_T , typename... Args>
Polynomial precice::mapping::RadialBasisFctMapping< SOLVER_T, Args >::_polynomial
private

Treatment of the polynomial.

Definition at line 71 of file RadialBasisFctMapping.hpp.

◆ _rbfSolver

template<typename SOLVER_T , typename... Args>
std::unique_ptr<SOLVER_T> precice::mapping::RadialBasisFctMapping< SOLVER_T, Args >::_rbfSolver
private

Definition at line 62 of file RadialBasisFctMapping.hpp.

◆ optionalArgs

template<typename SOLVER_T , typename... Args>
std::tuple<Args...> precice::mapping::RadialBasisFctMapping< SOLVER_T, Args >::optionalArgs
private

Optional constructor arguments for the solver class.

Definition at line 74 of file RadialBasisFctMapping.hpp.


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