Lethe Open-Source Library version 1.2.0
Developer Guide
Loading...
Searching...
No Matches
BoundaryConditions::CahnHilliardBoundaryConditions< dim > Class Template Reference

#include <cahn_hilliard_boundary_conditions.h>

Inheritance diagram for BoundaryConditions::CahnHilliardBoundaryConditions< dim >:
[legend]

Public Member Functions

void declare_default_entry (ParameterHandler &prm, types::boundary_id default_boundary_id)
void declare_parameters (ParameterHandler &prm, unsigned int number_of_boundary_conditions)
void parse_boundary (ParameterHandler &prm)
void parse_parameters (ParameterHandler &prm)

Public Attributes

std::map< types::boundary_id, double > angle_of_contact
std::map< types::boundary_id, double > phase_dirichlet_value
std::map< types::boundary_id, std::shared_ptr< CahnHilliardBoundaryFunctions< dim > > > bcFunctions
Public Attributes inherited from BoundaryConditions::BoundaryConditions< CahnHilliardBoundaryType >
std::map< types::boundary_id, CahnHilliardBoundaryType > type
unsigned int number_of_boundary_conditions
bool time_dependent
Parameters::PeriodicBoundaries periodic_boundaries

Detailed Description

template<int dim>
class BoundaryConditions::CahnHilliardBoundaryConditions< dim >

This class manages the boundary conditions for the Cahn-Hilliard solver It introduces the boundary functions and declares the boundary conditions coherently.

Definition at line 65 of file cahn_hilliard_boundary_conditions.h.

Member Function Documentation

◆ declare_default_entry()

template<int dim>
void BoundaryConditions::CahnHilliardBoundaryConditions< dim >::declare_default_entry ( ParameterHandler & prm,
types::boundary_id default_boundary_id )

Declare the default parameters for one Cahn-Hilliard boundary condition.

Parameters
[in,out]prmThe parameter handler object.
[in]default_boundary_idThe default mesh boundary id.

Definition at line 25 of file cahn_hilliard_boundary_conditions.cc.

References BoundaryConditions::cahn_hilliard_boundary_types, declare_enum_entry(), and BoundaryConditions::none.

◆ declare_parameters()

template<int dim>
void BoundaryConditions::CahnHilliardBoundaryConditions< dim >::declare_parameters ( ParameterHandler & prm,
unsigned int number_of_boundary_conditions )

Declare the Cahn-Hilliard boundary condition parameters.

Parameters
[in,out]prmThe parameter handler object.
[in]number_of_boundary_conditionsThe number of boundary conditions to declare.

Definition at line 68 of file cahn_hilliard_boundary_conditions.cc.

References declare_default_entry(), and BoundaryConditions::BoundaryConditions< CahnHilliardBoundaryType >::number_of_boundary_conditions.

◆ parse_boundary()

◆ parse_parameters()

template<int dim>
void BoundaryConditions::CahnHilliardBoundaryConditions< dim >::parse_parameters ( ParameterHandler & prm)

Member Data Documentation

◆ angle_of_contact

template<int dim>
std::map<types::boundary_id, double> BoundaryConditions::CahnHilliardBoundaryConditions< dim >::angle_of_contact

Definition at line 69 of file cahn_hilliard_boundary_conditions.h.

◆ bcFunctions

template<int dim>
std::map<types::boundary_id, std::shared_ptr<CahnHilliardBoundaryFunctions<dim> > > BoundaryConditions::CahnHilliardBoundaryConditions< dim >::bcFunctions

Definition at line 73 of file cahn_hilliard_boundary_conditions.h.

◆ phase_dirichlet_value

template<int dim>
std::map<types::boundary_id, double> BoundaryConditions::CahnHilliardBoundaryConditions< dim >::phase_dirichlet_value

Definition at line 70 of file cahn_hilliard_boundary_conditions.h.


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