PLaSK library

Loading...
Searching...
No Matches
Public Types | Public Member Functions | Public Attributes | List of all members
plask::BoundaryCondition< BoundaryT, ValueT > Struct Template Reference

One boundary-condition pair. More...

`#include <plask/mesh/boundary_conditions.hpp>`

## Public Types
typedef BoundaryT | Boundary
| Boundary type for mesh of type MeshType.
typedef Boundary::MeshType | MeshType
| type of mesh
typedef ValueT | ValueType
| type which describe boundary condition

## Public Member Functions
template<typename... ConditionArgumentsTypes>
| BoundaryCondition (const Boundary &place, ConditionArgumentsTypes &&... value_args)
| Construct boundary-condition pair.
template<typename... ConditionArgumentsTypes>
| BoundaryCondition (Boundary &&place, ConditionArgumentsTypes &&... value_args)
| Construct boundary-condition pair.

## Public Attributes
Boundary | place
| Boundary.
ValueType | value
| Condition.

## Detailed Description

template<typename BoundaryT, typename ValueT>
struct plask::BoundaryCondition< BoundaryT, ValueT >

One boundary-condition pair.

Definition at line 25 of file boundary_conditions.hpp.

## Member Typedef Documentation

## ◆ Boundary

template<typename BoundaryT , typename ValueT >

typedef BoundaryT plask::BoundaryCondition< BoundaryT, ValueT >::Boundary

Boundary type for mesh of type MeshType.

Definition at line 26 of file boundary_conditions.hpp.

## ◆ MeshType

template<typename BoundaryT , typename ValueT >

typedef Boundary::MeshType plask::BoundaryCondition< BoundaryT, ValueT >::MeshType

type of mesh

Definition at line 27 of file boundary_conditions.hpp.

## ◆ ValueType

template<typename BoundaryT , typename ValueT >

typedef ValueT plask::BoundaryCondition< BoundaryT, ValueT >::ValueType

type which describe boundary condition

Definition at line 28 of file boundary_conditions.hpp.

## Constructor & Destructor Documentation

## ◆ BoundaryCondition() [1/2]

template<typename BoundaryT , typename ValueT >
template<typename... ConditionArgumentsTypes>

plask::BoundaryCondition< BoundaryT, ValueT >::BoundaryCondition | ( | const Boundary & | place,
|  | ConditionArgumentsTypes &&... | value_args
| ) |  |
| inline

Construct boundary-condition pair.

Parameters

  place | boundary
  value_args | arguments for condition constructor, can be just one argument of ValueType to use copy/move-constructor

Definition at line 39 of file boundary_conditions.hpp.

## ◆ BoundaryCondition() [2/2]

template<typename BoundaryT , typename ValueT >
template<typename... ConditionArgumentsTypes>

plask::BoundaryCondition< BoundaryT, ValueT >::BoundaryCondition | ( | Boundary && | place,
|  | ConditionArgumentsTypes &&... | value_args
| ) |  |
| inline

Construct boundary-condition pair.

Parameters

  place | boundary
  value_args | arguments for condition constructor, can be just one argument of ValueType to use copy/move-constructor

Definition at line 49 of file boundary_conditions.hpp.

## Member Data Documentation

## ◆ place

template<typename BoundaryT , typename ValueT >

Boundary plask::BoundaryCondition< BoundaryT, ValueT >::place

Boundary.

Definition at line 30 of file boundary_conditions.hpp.

## ◆ value

template<typename BoundaryT , typename ValueT >

ValueType plask::BoundaryCondition< BoundaryT, ValueT >::value

Condition.

Definition at line 31 of file boundary_conditions.hpp.

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

- plask/mesh/boundary_conditions.hpp