Lethe Open-Source Library version 1.2.0
Developer Guide
Loading...
Searching...
No Matches
Parameters::CahnHilliard Struct Reference

#include <parameters_multiphysics.h>

Public Member Functions

void declare_parameters (ParameterHandler &prm) const
void parse_parameters (ParameterHandler &prm, const Dimensionality &dimensions)

Public Attributes

double potential_smoothing_coefficient = 1
Parameters::EpsilonSetMethod epsilon_set_method
Parameters::EpsilonVerbosity epsilon_verbosity = EpsilonVerbosity::quiet
double epsilon = 1.0
Parameters::CahnHilliard_PhaseFilter cahn_hilliard_phase_filter

Detailed Description

Definition at line 492 of file parameters_multiphysics.h.

Member Function Documentation

◆ declare_parameters()

void CahnHilliard< dim >::declare_parameters ( ParameterHandler & prm) const

Declare the Cahn-Hilliard parameters.

Parameters
[in,out]prmThe parameter handler object.

Definition at line 757 of file parameters_multiphysics.cc.

References cahn_hilliard_phase_filter, declare_enum_entry(), epsilon, epsilon_set_method, epsilon_verbosity, and potential_smoothing_coefficient.

◆ parse_parameters()

void CahnHilliard< dim >::parse_parameters ( ParameterHandler & prm,
const Dimensionality & dimensions )

Parse the Cahn-Hilliard parameters.

Parameters
[in]prmThe parameter handler object.
[in]dimensionsDimensionality used to interpret the parameter units.

Definition at line 796 of file parameters_multiphysics.cc.

References Parameters::Dimensionality::cahn_hilliard_epsilon_scaling, cahn_hilliard_phase_filter, epsilon, epsilon_set_method, epsilon_verbosity, potential_smoothing_coefficient, and string_to_enum().

Member Data Documentation

◆ cahn_hilliard_phase_filter

Parameters::CahnHilliard_PhaseFilter Parameters::CahnHilliard::cahn_hilliard_phase_filter

Definition at line 509 of file parameters_multiphysics.h.

◆ epsilon

double Parameters::CahnHilliard::epsilon = 1.0

Definition at line 506 of file parameters_multiphysics.h.

◆ epsilon_set_method

Parameters::EpsilonSetMethod Parameters::CahnHilliard::epsilon_set_method

◆ epsilon_verbosity

Parameters::EpsilonVerbosity Parameters::CahnHilliard::epsilon_verbosity = EpsilonVerbosity::quiet

Definition at line 503 of file parameters_multiphysics.h.

◆ potential_smoothing_coefficient

double Parameters::CahnHilliard::potential_smoothing_coefficient = 1

Definition at line 496 of file parameters_multiphysics.h.


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