Chaste  Release::2018.1
FunctionalBoundaryCondition< SPACE_DIM > Class Template Reference

#include <FunctionalBoundaryCondition.hpp>

+ Inheritance diagram for FunctionalBoundaryCondition< SPACE_DIM >:
+ Collaboration diagram for FunctionalBoundaryCondition< SPACE_DIM >:

Public Member Functions

 FunctionalBoundaryCondition (double(*func)(const ChastePoint< SPACE_DIM > &rX))
 
double GetValue (const ChastePoint< SPACE_DIM > &rX) const
 
- Public Member Functions inherited from AbstractBoundaryCondition< SPACE_DIM >
 AbstractBoundaryCondition ()
 
virtual ~AbstractBoundaryCondition ()
 

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 47 of file FunctionalBoundaryCondition.hpp.

Constructor & Destructor Documentation

template<unsigned SPACE_DIM>
FunctionalBoundaryCondition< SPACE_DIM >::FunctionalBoundaryCondition ( double(*)(const ChastePoint< SPACE_DIM > &rX)  func)

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

Parameters
funcPointer to a function to be used for evaluating this boundary condition

Definition at line 39 of file FunctionalBoundaryCondition.cpp.

Member Function Documentation

template<unsigned SPACE_DIM>
double FunctionalBoundaryCondition< SPACE_DIM >::GetValue ( const ChastePoint< SPACE_DIM > &  rX) const
virtual
Returns
the value of the boundary condition at a given point.
Parameters
rXa point in space

Implements AbstractBoundaryCondition< SPACE_DIM >.

Definition at line 45 of file FunctionalBoundaryCondition.cpp.

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
rXa point in space

Definition at line 56 of file FunctionalBoundaryCondition.hpp.


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