FunctionalBoundaryCondition< SPACE_DIM > Class Template Reference

#include <FunctionalBoundaryCondition.hpp>

Inherits AbstractBoundaryCondition< SPACE_DIM >.

Collaboration diagram for FunctionalBoundaryCondition< SPACE_DIM >:

[legend]

List of all members.

Public Member Functions
	FunctionalBoundaryCondition (double(*func)(const ChastePoint< SPACE_DIM > &rX))
double	GetValue (const ChastePoint< SPACE_DIM > &rX) const
Private Attributes
double(*	mFunction )(const ChastePoint< SPACE_DIM > &rX)

---

Detailed Description

template<unsigned SPACE_DIM>
class FunctionalBoundaryCondition< SPACE_DIM >

A boundary condition that takes a function pointer in its constructor, and evaluates the function to determine the value of the condition at a given point.

Definition at line 40 of file FunctionalBoundaryCondition.hpp.

---

Constructor & Destructor Documentation

template<unsigned SPACE_DIM>

FunctionalBoundaryCondition< SPACE_DIM >::FunctionalBoundaryCondition

(

double(*)(const ChastePoint< SPACE_DIM > &rX)

func

)

[inline]

Typical use: pBoundaryCondition = new FunctionalBoundaryCondition(&function_name);

Parameters:

func

Pointer to a function to be used for evaluating this boundary condition

Definition at line 32 of file FunctionalBoundaryCondition.cpp.

---

Member Function Documentation

template<unsigned SPACE_DIM>

double FunctionalBoundaryCondition< SPACE_DIM >::GetValue

(

const ChastePoint< SPACE_DIM > &

rX

)

const [inline, virtual]

Get the value of the boundary condition at a given point.

Parameters:

rX

a point in space

Implements AbstractBoundaryCondition< SPACE_DIM >.

Definition at line 38 of file FunctionalBoundaryCondition.cpp.

References FunctionalBoundaryCondition< SPACE_DIM >::mFunction.

---

Member Data Documentation

template<unsigned SPACE_DIM>

double(* FunctionalBoundaryCondition< SPACE_DIM >::mFunction)(const ChastePoint< SPACE_DIM > &rX) [private]

The function pointer used to determine the value of the boundary condition at a given point.

Parameters:

rX

a point in space

Definition at line 49 of file FunctionalBoundaryCondition.hpp.

Referenced by FunctionalBoundaryCondition< SPACE_DIM >::GetValue().

---

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

• pde/src/common/FunctionalBoundaryCondition.hpp
• pde/src/common/FunctionalBoundaryCondition.cpp