ABLATE Source Documentation  0.12.36
ablate::domain::modifiers::EdgeClusteringMapper Class Reference

#include <edgeClusteringMapper.hpp>

+ Inheritance diagram for ablate::domain::modifiers::EdgeClusteringMapper:

Public Member Functions

 EdgeClusteringMapper (int direction, double start, double end, double beta, std::shared_ptr< ablate::domain::Region > mappingRegion={})
 
std::string ToString () const override
 
- Public Member Functions inherited from ablate::domain::modifiers::MeshMapper
 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)
 

Detailed Description

Performs clustering mapping using an algebraic relationship at the edges of the domain using Equation 9-42 from Hoffmann, Klaus A., and Steve T. Chiang. "Computational fluid dynamics volume I. Forth Edition" Engineering education system (2000).

Constructor & Destructor Documentation

◆ EdgeClusteringMapper()

ablate::domain::modifiers::EdgeClusteringMapper::EdgeClusteringMapper ( int  direction,
double  start,
double  end,
double  beta,
std::shared_ptr< ablate::domain::Region mappingRegion = {} 
)
explicit

Performs one point clustering

Parameters
directionThe direction (0, 1, 2) to perform the mapping
startThe start of the domain in direction
endThe end of the domain in direction
betaThe clustering factor
mappingRegionoptional region to apply this mapper. Default is everywhere

Member Function Documentation

◆ ToString()

std::string ablate::domain::modifiers::EdgeClusteringMapper::ToString ( ) const
overridevirtual

Provide name of modifier for debug/output

Returns

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


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