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

#include <cahn_hilliard_filter.h>

Inheritance diagram for CahnHilliardClipFilter:
[legend]

Public Member Functions

 CahnHilliardClipFilter ()=default
virtual double filter_phase (const double &unfiltered_phase) override
Public Member Functions inherited from CahnHilliardFilterBase
 CahnHilliardFilterBase ()=default
virtual ~CahnHilliardFilterBase ()=default

Additional Inherited Members

Static Public Member Functions inherited from CahnHilliardFilterBase
static std::shared_ptr< CahnHilliardFilterBase > model_cast (const Parameters::CahnHilliard &cahn_hilliard_parameters)

Detailed Description

Calculate a filtered phase fraction for Cahn-Hilliard simulations. In this case, a simple clamping is performed on the phase fraction parameter for it to remain in the [-1,1] interval.

Definition at line 65 of file cahn_hilliard_filter.h.

Constructor & Destructor Documentation

◆ CahnHilliardClipFilter()

CahnHilliardClipFilter::CahnHilliardClipFilter ( )
default

Member Function Documentation

◆ filter_phase()

virtual double CahnHilliardClipFilter::filter_phase ( const double & unfiltered_phase)
inlineoverridevirtual

Calculate the value of the filtered phase fraction.

Parameters
[in]unfiltered_phaseValue of the phase fraction before applying the filter.
Returns
Value of the phase fraction after applying the filter.

Implements CahnHilliardFilterBase.

Definition at line 77 of file cahn_hilliard_filter.h.

References sgn().


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