Lethe Open-Source Library version 1.2.0
Developer Guide
Loading...
Searching...
No Matches
SignedDistanceTransformationBase Class Referenceabstract

#include <signed_distance_transformation.h>

Inheritance diagram for SignedDistanceTransformationBase:
[legend]

Public Member Functions

virtual ~SignedDistanceTransformationBase ()=default
virtual double transform_signed_distance (const double signed_distance)=0

Static Public Member Functions

static std::shared_ptr< SignedDistanceTransformationBase > model_cast (const Parameters::CLS_GeometricInterfaceReinitialization &geometric_redistanciation_parameters)

Detailed Description

Abstract class for the transformation of the signed distance to the phase indicator for the CLS solver when geometric redistanciation is used.

Definition at line 14 of file signed_distance_transformation.h.

Constructor & Destructor Documentation

◆ ~SignedDistanceTransformationBase()

virtual SignedDistanceTransformationBase::~SignedDistanceTransformationBase ( )
virtualdefault

Default destructor.

Member Function Documentation

◆ model_cast()

std::shared_ptr< SignedDistanceTransformationBase > SignedDistanceTransformationBase::model_cast ( const Parameters::CLS_GeometricInterfaceReinitialization & geometric_redistanciation_parameters)
static

Instantiate and return a pointer to a SignedDistanceTransformationBase object by casting it to the proper child class.

Parameters
[in]geometric_redistanciation_parametersCLS geometric redistanciation parameters.
Returns
Casted SignedDistanceTransformationBase child class object.

Definition at line 7 of file signed_distance_transformation.cc.

References Parameters::CLS_GeometricInterfaceReinitialization::max_reinitialization_distance, Parameters::piecewise_polynomial, Parameters::CLS_GeometricInterfaceReinitialization::tanh_thickness, and Parameters::CLS_GeometricInterfaceReinitialization::transformation_type.

◆ transform_signed_distance()

virtual double SignedDistanceTransformationBase::transform_signed_distance ( const double signed_distance)
inlinepure virtual

Compute the value of the phase indicator from the signed distance.

Parameters
[in]signed_distanceValue of the signed distance
Returns
Value of the computed phase indicator after applying the transformation.

Implemented in SignedDistanceTransformationPiecewisePolynomial, and SignedDistanceTransformationTanh.


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