Lethe Open-Source Library version 1.2.0
Developer Guide
Loading...
Searching...
No Matches
SignedDistanceTransformationTanh Class Reference

#include <signed_distance_transformation.h>

Inheritance diagram for SignedDistanceTransformationTanh:
[legend]

Public Member Functions

 SignedDistanceTransformationTanh (const double tanh_thickness)
double transform_signed_distance (const double signed_distance) override
Public Member Functions inherited from SignedDistanceTransformationBase
virtual ~SignedDistanceTransformationBase ()=default

Private Attributes

const double tanh_thickness

Additional Inherited Members

Static Public Member Functions inherited from SignedDistanceTransformationBase
static std::shared_ptr< SignedDistanceTransformationBase > model_cast (const Parameters::CLS_GeometricInterfaceReinitialization &geometric_redistanciation_parameters)

Detailed Description

Transforms the signed distance to the phase indicator with a hyperbolic tangent function.

The phase indicator is defined as:

\(\phi = 0.5 - 0.5 \tanh(d/\varepsilon)\)

where \(d\) is the signed distance and \(\varepsilon\) is a model parameter giving a measure of the interface thickness.

Definition at line 61 of file signed_distance_transformation.h.

Constructor & Destructor Documentation

◆ SignedDistanceTransformationTanh()

SignedDistanceTransformationTanh::SignedDistanceTransformationTanh ( const double tanh_thickness)
inline

Constructor of the hyperbolic tangent signed distance transformation.

Parameters
[in]tanh_thicknessValue of the \(\varepsilon\) parameter modulating the interface thickness.

Definition at line 70 of file signed_distance_transformation.h.

References tanh_thickness.

Member Function Documentation

◆ transform_signed_distance()

double SignedDistanceTransformationTanh::transform_signed_distance ( const double signed_distance)
inlineoverridevirtual

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

Implements SignedDistanceTransformationBase.

Definition at line 83 of file signed_distance_transformation.h.

References tanh_thickness.

Member Data Documentation

◆ tanh_thickness

const double SignedDistanceTransformationTanh::tanh_thickness
private

User-defined parameter that defines the thickness of the interface. It influences its sharpness: a smaller value leads to a sharper interface.

Definition at line 93 of file signed_distance_transformation.h.


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