![]() |
Lethe Open-Source Library version 1.2.0
Developer Guide
|
#include <cls_filter.h>
Public Member Functions | |
| ConservativeLevelSetTanhFilter (const double beta) | |
| virtual double | filter_phase (const double &unfiltered_phase) override |
| Public Member Functions inherited from ConservativeLevelSetFilterBase | |
| virtual | ~ConservativeLevelSetFilterBase ()=default |
Private Attributes | |
| const double | beta |
Additional Inherited Members | |
| Static Public Member Functions inherited from ConservativeLevelSetFilterBase | |
| static std::shared_ptr< ConservativeLevelSetFilterBase > | model_cast (const Parameters::CLS_PhaseFilter &phase_filter_parameters) |
Filter phase indicator with a hyperbolic tangent function for CLS simulations.
The filtered phase is defined as:
\(\phi' = 0.5 \tanh(\beta(\phi-0.5)) + 0.5\)
where \(\phi'\) is the filtered phase indicator value and \(\beta\) is a model parameter that enables sharper definition when increased.
The filter allows a sharper definition of the interface and clamps the value of the phase indicator between 0 and 1.
Definition at line 92 of file cls_filter.h.
|
inline |
Constructor of the hyperbolic tangent phase indicator filter.
| [in] | beta | Value of the \(\beta\) parameter modulating the interface sharpness. |
Definition at line 101 of file cls_filter.h.
References beta.
|
inlineoverridevirtual |
Computes the value of the filtered phase indicator.
| [in] | unfiltered_phase | Value of the phase indicator before applying the filter. |
Implements ConservativeLevelSetFilterBase.
Definition at line 114 of file cls_filter.h.
References beta.
|
private |
User-defined parameter that influences the sharpness of the interface between fluids. A greater value leads to a sharper interface. The recommended value is \(\beta=20\).
Definition at line 125 of file cls_filter.h.