AbstractBoundaryConditionsContainer< ELEM_DIM, SPACE_DIM, PROBLEM_DIM > Class Template Reference
#include <AbstractBoundaryConditionsContainer.hpp>
Public Member Functions | |
| AbstractBoundaryConditionsContainer () | |
| ~AbstractBoundaryConditionsContainer () | |
| bool | HasDirichletBoundaryConditions () |
| void | DeleteDirichletBoundaryConditions (std::set< const AbstractBoundaryCondition< SPACE_DIM > * > deletedConditions=std::set< const AbstractBoundaryCondition< SPACE_DIM > * >()) |
| double | GetDirichletBCValue (const Node< SPACE_DIM > *pBoundaryNode, unsigned indexOfUnknown=0) |
| bool | HasDirichletBoundaryCondition (const Node< SPACE_DIM > *pNode, unsigned indexOfUnknown=0) |
Protected Attributes | |
| std::map< const Node < SPACE_DIM > *, const AbstractBoundaryCondition < SPACE_DIM > *, LessThanNode < SPACE_DIM > > * | mpDirichletMap [PROBLEM_DIM] |
| std::map< const Node < SPACE_DIM > *, const AbstractBoundaryCondition < SPACE_DIM > *, LessThanNode < SPACE_DIM > >::const_iterator | mDirichIterator |
Detailed Description
template<unsigned ELEM_DIM, unsigned SPACE_DIM, unsigned PROBLEM_DIM>
class AbstractBoundaryConditionsContainer< ELEM_DIM, SPACE_DIM, PROBLEM_DIM >
Abstract boundary conditions container.
Definition at line 63 of file AbstractBoundaryConditionsContainer.hpp.
Constructor & Destructor Documentation
| AbstractBoundaryConditionsContainer< ELEM_DIM, SPACE_DIM, PROBLEM_DIM >::AbstractBoundaryConditionsContainer | ( | ) | [inline] |
Constructor allocates memory for the Dirichlet boundary conditions lists.
Definition at line 36 of file AbstractBoundaryConditionsContainerImplementation.hpp.
References AbstractBoundaryConditionsContainer< ELEM_DIM, SPACE_DIM, PROBLEM_DIM >::mpDirichletMap.
| AbstractBoundaryConditionsContainer< ELEM_DIM, SPACE_DIM, PROBLEM_DIM >::~AbstractBoundaryConditionsContainer | ( | ) | [inline] |
Destructor.
Definition at line 45 of file AbstractBoundaryConditionsContainerImplementation.hpp.
References AbstractBoundaryConditionsContainer< ELEM_DIM, SPACE_DIM, PROBLEM_DIM >::DeleteDirichletBoundaryConditions().
Member Function Documentation
| bool AbstractBoundaryConditionsContainer< ELEM_DIM, SPACE_DIM, PROBLEM_DIM >::HasDirichletBoundaryConditions | ( | ) | [inline] |
Return whether any Dirichlet conditions are defined (for ANY of the unknowns).
Definition at line 51 of file AbstractBoundaryConditionsContainerImplementation.hpp.
References AbstractBoundaryConditionsContainer< ELEM_DIM, SPACE_DIM, PROBLEM_DIM >::mpDirichletMap.
Referenced by BidomainDg0Assembler< ELEMENT_DIM, SPACE_DIM >::CheckCompatibilityCondition(), and BidomainDg0Assembler< ELEMENT_DIM, SPACE_DIM >::FinaliseAssembleSystem().
| void AbstractBoundaryConditionsContainer< ELEM_DIM, SPACE_DIM, PROBLEM_DIM >::DeleteDirichletBoundaryConditions | ( | std::set< const AbstractBoundaryCondition< SPACE_DIM > * > | deletedConditions = std::set<const AbstractBoundaryCondition<SPACE_DIM>*>() |
) | [inline] |
Delete list of Dirichlet boundary conditions.
- Parameters:
-
deletedConditions (optional)
Definition at line 64 of file AbstractBoundaryConditionsContainerImplementation.hpp.
References AbstractBoundaryConditionsContainer< ELEM_DIM, SPACE_DIM, PROBLEM_DIM >::mDirichIterator, and AbstractBoundaryConditionsContainer< ELEM_DIM, SPACE_DIM, PROBLEM_DIM >::mpDirichletMap.
Referenced by AbstractBoundaryConditionsContainer< ELEM_DIM, SPACE_DIM, PROBLEM_DIM >::~AbstractBoundaryConditionsContainer(), and BoundaryConditionsContainer< ELEM_DIM, SPACE_DIM, PROBLEM_DIM >::~BoundaryConditionsContainer().
| double AbstractBoundaryConditionsContainer< ELEM_DIM, SPACE_DIM, PROBLEM_DIM >::GetDirichletBCValue | ( | const Node< SPACE_DIM > * | pBoundaryNode, | |
| unsigned | indexOfUnknown = 0 | |||
| ) | [inline] |
Obtain value of Dirichlet boundary condition at specified node.
This is unlikely to be needed by the user, the methods ApplyDirichletToLinearProblem or ApplyDirichletToNonlinearProblem can be called instead to apply all Dirichlet boundary conditions at the same time.
- Parameters:
-
pBoundaryNode pointer to a boundary node indexOfUnknown index of the unknown for which to obtain the value of the boundary condition (defaults to 0)
Definition at line 88 of file AbstractBoundaryConditionsContainerImplementation.hpp.
References Node< SPACE_DIM >::GetPoint(), AbstractBoundaryConditionsContainer< ELEM_DIM, SPACE_DIM, PROBLEM_DIM >::mDirichIterator, and AbstractBoundaryConditionsContainer< ELEM_DIM, SPACE_DIM, PROBLEM_DIM >::mpDirichletMap.
| bool AbstractBoundaryConditionsContainer< ELEM_DIM, SPACE_DIM, PROBLEM_DIM >::HasDirichletBoundaryCondition | ( | const Node< SPACE_DIM > * | pNode, | |
| unsigned | indexOfUnknown = 0 | |||
| ) | [inline] |
Test if there is a Dirichlet boundary condition defined on the given node.
- Todo:
- Perhaps have flag in node object for efficiency?
- Parameters:
-
pNode pointer to a node indexOfUnknown index of the unknown for which to obtain the value of the boundary condition (defaults to 0)
Definition at line 100 of file AbstractBoundaryConditionsContainerImplementation.hpp.
References AbstractBoundaryConditionsContainer< ELEM_DIM, SPACE_DIM, PROBLEM_DIM >::mDirichIterator, and AbstractBoundaryConditionsContainer< ELEM_DIM, SPACE_DIM, PROBLEM_DIM >::mpDirichletMap.
Referenced by BoundaryConditionsContainer< ELEM_DIM, SPACE_DIM, PROBLEM_DIM >::Validate().
Member Data Documentation
std::map< const Node<SPACE_DIM> *, const AbstractBoundaryCondition<SPACE_DIM>*, LessThanNode<SPACE_DIM> >* AbstractBoundaryConditionsContainer< ELEM_DIM, SPACE_DIM, PROBLEM_DIM >::mpDirichletMap[PROBLEM_DIM] [protected] |
List (map) of Dirichlet boundary conditions
Definition at line 67 of file AbstractBoundaryConditionsContainer.hpp.
Referenced by AbstractBoundaryConditionsContainer< ELEM_DIM, SPACE_DIM, PROBLEM_DIM >::AbstractBoundaryConditionsContainer(), BoundaryConditionsContainer< ELEM_DIM, SPACE_DIM, PROBLEM_DIM >::AddDirichletBoundaryCondition(), BoundaryConditionsContainer< ELEM_DIM, SPACE_DIM, PROBLEM_DIM >::ApplyDirichletToLinearProblem(), BoundaryConditionsContainer< ELEM_DIM, SPACE_DIM, PROBLEM_DIM >::ApplyDirichletToNonlinearJacobian(), BoundaryConditionsContainer< ELEM_DIM, SPACE_DIM, PROBLEM_DIM >::ApplyDirichletToNonlinearResidual(), AbstractBoundaryConditionsContainer< ELEM_DIM, SPACE_DIM, PROBLEM_DIM >::DeleteDirichletBoundaryConditions(), AbstractBoundaryConditionsContainer< ELEM_DIM, SPACE_DIM, PROBLEM_DIM >::GetDirichletBCValue(), AbstractBoundaryConditionsContainer< ELEM_DIM, SPACE_DIM, PROBLEM_DIM >::HasDirichletBoundaryCondition(), and AbstractBoundaryConditionsContainer< ELEM_DIM, SPACE_DIM, PROBLEM_DIM >::HasDirichletBoundaryConditions().
std::map< const Node<SPACE_DIM> *, const AbstractBoundaryCondition<SPACE_DIM>*, LessThanNode<SPACE_DIM> >::const_iterator AbstractBoundaryConditionsContainer< ELEM_DIM, SPACE_DIM, PROBLEM_DIM >::mDirichIterator [protected] |
Internal iterator over Dirichlet boundary conditions
Definition at line 70 of file AbstractBoundaryConditionsContainer.hpp.
Referenced by BoundaryConditionsContainer< ELEM_DIM, SPACE_DIM, PROBLEM_DIM >::ApplyDirichletToLinearProblem(), BoundaryConditionsContainer< ELEM_DIM, SPACE_DIM, PROBLEM_DIM >::ApplyDirichletToNonlinearJacobian(), BoundaryConditionsContainer< ELEM_DIM, SPACE_DIM, PROBLEM_DIM >::ApplyDirichletToNonlinearResidual(), AbstractBoundaryConditionsContainer< ELEM_DIM, SPACE_DIM, PROBLEM_DIM >::DeleteDirichletBoundaryConditions(), AbstractBoundaryConditionsContainer< ELEM_DIM, SPACE_DIM, PROBLEM_DIM >::GetDirichletBCValue(), and AbstractBoundaryConditionsContainer< ELEM_DIM, SPACE_DIM, PROBLEM_DIM >::HasDirichletBoundaryCondition().
The documentation for this class was generated from the following files:
- /tmp/release_1.1/pde/src/common/AbstractBoundaryConditionsContainer.hpp
- /tmp/release_1.1/pde/src/common/AbstractBoundaryConditionsContainerImplementation.hpp
