ABLATE Source Documentation  0.12.36
ablate::domain::modifiers::MeshMapper Class Reference
+ Inheritance diagram for ablate::domain::modifiers::MeshMapper:

Public Member Functions

 MeshMapper (std::shared_ptr< ablate::mathFunctions::MathFunction > mappingFunction, std::shared_ptr< ablate::domain::Region > mappingRegion={})
 
void Modify (DM &) override
 
void Modify (const std::vector< double > &in, std::vector< double > &out) const
 
std::string ToString () const override
 

Additional Inherited Members

- Static Protected Member Functions inherited from ablate::domain::modifiers::Modifier
static void ReplaceDm (DM &originalDm, DM &replaceDm)
 

Constructor & Destructor Documentation

◆ MeshMapper()

ablate::domain::modifiers::MeshMapper::MeshMapper ( std::shared_ptr< ablate::mathFunctions::MathFunction mappingFunction,
std::shared_ptr< ablate::domain::Region mappingRegion = {} 
)
explicit

General constructor for all mesh mappers

Parameters
mappingFunctionThe mapping function that takes input coordinates and maps them to output
mappingRegionan optional region to apply the mesh mapping

Member Function Documentation

◆ Modify() [1/2]

void ablate::domain::modifiers::MeshMapper::Modify ( const std::vector< double > &  in,
std::vector< double > &  out 
) const

This returns a single modified point value.

Parameters
in
outwill be resized to match in

◆ Modify() [2/2]

void ablate::domain::modifiers::MeshMapper::Modify ( DM &  dm)
overridevirtual

March over each vertex in the cell and map using the supplied function

Implements ablate::domain::modifiers::Modifier.

◆ ToString()

std::string ablate::domain::modifiers::MeshMapper::ToString ( ) const
inlineoverridevirtual

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