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

#include <boundary_conditions.h>

Public Attributes

std::map< types::boundary_id, BoundaryType > type
unsigned int number_of_boundary_conditions
bool time_dependent
Parameters::PeriodicBoundaries periodic_boundaries

Detailed Description

template<typename BoundaryType>
requires std::is_enum_v<BoundaryType>
class BoundaryConditions::BoundaryConditions< BoundaryType >

This class is the base class for all boundary conditions. It stores the general information that all boundary condition share. In Lethe, boundary conditions are identified with an id, a type and, in the special case of periodic boundary condition, a periodic matching id (periodic_id) and a periodic direction (0, 1 or 2).

Template Parameters
BoundaryTypeEnumeration of the boundary condition types of the physics (e.g. FluidDynamicsBoundaryType).

Definition at line 30 of file boundary_conditions.h.

Member Data Documentation

◆ number_of_boundary_conditions

template<typename BoundaryType>
unsigned int BoundaryConditions::BoundaryConditions< BoundaryType >::number_of_boundary_conditions

Number of boundary conditions.

Definition at line 37 of file boundary_conditions.h.

◆ periodic_boundaries

template<typename BoundaryType>
Parameters::PeriodicBoundaries BoundaryConditions::BoundaryConditions< BoundaryType >::periodic_boundaries

Periodic boundary pairs, keyed by the principal periodic boundary id.

Definition at line 43 of file boundary_conditions.h.

◆ time_dependent

template<typename BoundaryType>
bool BoundaryConditions::BoundaryConditions< BoundaryType >::time_dependent

indicator for transient BCs

Definition at line 40 of file boundary_conditions.h.

◆ type

template<typename BoundaryType>
std::map<types::boundary_id, BoundaryType> BoundaryConditions::BoundaryConditions< BoundaryType >::type

Map containing the boundary id and the boundary type.

Definition at line 34 of file boundary_conditions.h.


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