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

#include <cahn_hilliard_filter.h>

Inheritance diagram for CahnHilliardTanhFilter:
[legend]

Public Member Functions

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

Private Attributes

const double beta

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.

The filtered phase is defined as \(\phi_f = \tanh(\beta \phi)\) with \( \phi \) the unfiltered phase field.

Definition at line 90 of file cahn_hilliard_filter.h.

Constructor & Destructor Documentation

◆ CahnHilliardTanhFilter()

CahnHilliardTanhFilter::CahnHilliardTanhFilter ( const double beta)
inline

Definition at line 93 of file cahn_hilliard_filter.h.

References beta.

Member Function Documentation

◆ filter_phase()

virtual double CahnHilliardTanhFilter::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 104 of file cahn_hilliard_filter.h.

References beta.

Member Data Documentation

◆ beta

const double CahnHilliardTanhFilter::beta
private

User-defined parameter that influences how sharp the filtering is.

Definition at line 113 of file cahn_hilliard_filter.h.


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