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

#include <cahn_hilliard_filter.h>

Inheritance diagram for CahnHilliardFilterBase:
[legend]

Public Member Functions

 CahnHilliardFilterBase ()=default
virtual ~CahnHilliardFilterBase ()=default
virtual double filter_phase (const double &unfiltered_phase)=0

Static Public Member Functions

static std::shared_ptr< CahnHilliardFilterBase > model_cast (const Parameters::CahnHilliard &cahn_hilliard_parameters)

Detailed Description

Filter phase fraction according to the selected filtering method.

Definition at line 12 of file cahn_hilliard_filter.h.

Constructor & Destructor Documentation

◆ CahnHilliardFilterBase()

CahnHilliardFilterBase::CahnHilliardFilterBase ( )
default

◆ ~CahnHilliardFilterBase()

virtual CahnHilliardFilterBase::~CahnHilliardFilterBase ( )
virtualdefault

Default destructor.

Member Function Documentation

◆ filter_phase()

virtual double CahnHilliardFilterBase::filter_phase ( const double & unfiltered_phase)
pure virtual

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.

Implemented in CahnHilliardClipFilter, CahnHilliardNoFilter, and CahnHilliardTanhFilter.

◆ model_cast()

std::shared_ptr< CahnHilliardFilterBase > CahnHilliardFilterBase::model_cast ( const Parameters::CahnHilliard & cahn_hilliard_parameters)
static

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

Parameters
[in]cahn_hilliard_parametersCahnHilliard model parameters.

Definition at line 7 of file cahn_hilliard_filter.cc.

References Parameters::CahnHilliard_PhaseFilter::beta, Parameters::CahnHilliard::cahn_hilliard_phase_filter, Parameters::clip, Parameters::tanh, and Parameters::CahnHilliard_PhaseFilter::type.


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