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

#include <cls_filter.h>

Inheritance diagram for ConservativeLevelSetFilterBase:
[legend]

Public Member Functions

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

Static Public Member Functions

static std::shared_ptr< ConservativeLevelSetFilterBase > model_cast (const Parameters::CLS_PhaseFilter &phase_filter_parameters)

Detailed Description

Abstract class for filtering phase indicator in Conservative Level Set (CLS) simulations.

Definition at line 14 of file cls_filter.h.

Constructor & Destructor Documentation

◆ ~ConservativeLevelSetFilterBase()

virtual ConservativeLevelSetFilterBase::~ConservativeLevelSetFilterBase ( )
virtualdefault

Default destructor.

Member Function Documentation

◆ filter_phase()

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

Compute the value of the filtered phase indicator.

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

Implemented in ConservativeLevelSetNoFilter, and ConservativeLevelSetTanhFilter.

◆ model_cast()

std::shared_ptr< ConservativeLevelSetFilterBase > ConservativeLevelSetFilterBase::model_cast ( const Parameters::CLS_PhaseFilter & phase_filter_parameters)
static

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

Parameters
[in]phase_filter_parametersCLS filtration parameters.
Returns
Casted ConservativeLevelSetFilterBase child class object.

Definition at line 7 of file cls_filter.cc.

References Parameters::CLS_PhaseFilter::beta, Parameters::tanh, and Parameters::CLS_PhaseFilter::type.


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