Chaste Release::3.1
GaussianQuadratureRule< ELEMENT_DIM > Class Template Reference

#include <GaussianQuadratureRule.hpp>

Inheritance diagram for GaussianQuadratureRule< ELEMENT_DIM >:
Collaboration diagram for GaussianQuadratureRule< ELEMENT_DIM >:

List of all members.

Public Member Functions

 GaussianQuadratureRule (unsigned numPointsInEachDimension)
const ChastePoint< ELEMENT_DIM > & rGetQuadPoint (unsigned index) const
double GetWeight (unsigned index) const
unsigned GetNumQuadPoints () const
template<>
 GaussianQuadratureRule (unsigned numPointsInEachDimension)
template<>
 GaussianQuadratureRule (unsigned numPointsInEachDimension)
template<>
 GaussianQuadratureRule (unsigned numPointsInEachDimension)

Private Attributes

unsigned mNumQuadPoints
std::vector< ChastePoint
< ELEMENT_DIM > > 
mPoints
std::vector< doublemWeights

Detailed Description

template<unsigned ELEMENT_DIM>
class GaussianQuadratureRule< ELEMENT_DIM >

This class encapsulates tables of gaussian quadrature points and the associated weights.

Data is available for 1d, 2d and 3d quadrature over (canonical) triangles, with between 1 and 3 (inclusive) Gauss points in each dimension. The values are computed when an object is instantiated.

Definition at line 50 of file GaussianQuadratureRule.hpp.


Constructor & Destructor Documentation

template<unsigned ELEMENT_DIM>
GaussianQuadratureRule< ELEMENT_DIM >::GaussianQuadratureRule ( unsigned  numPointsInEachDimension)

The constructor builds the appropriate table for the dimension (given by the template argument) and number of points in each dimension (given as a constructor argument).

An exception is thrown if data is not available for the requested parameters.

Parameters:
numPointsInEachDimensionnumber of Gauss points in each dimension

Definition at line 667 of file GaussianQuadratureRule.cpp.

References EXCEPTION.

template<>
GaussianQuadratureRule< 0 >::GaussianQuadratureRule ( unsigned  numPointsInEachDimension)

Constructor specialization for 0d.

Parameters:
numPointsInEachDimensionnumber of Gauss points in each dimension

Definition at line 68 of file GaussianQuadratureRule.cpp.

template<>
GaussianQuadratureRule< 2 >::GaussianQuadratureRule ( unsigned  numPointsInEachDimension)

Constructor specialization for 2d.

Parameters:
numPointsInEachDimensionnumber of Gauss points in each dimension

Definition at line 162 of file GaussianQuadratureRule.cpp.

References EXCEPTION.

template<>
GaussianQuadratureRule< 3 >::GaussianQuadratureRule ( unsigned  numPointsInEachDimension)

Constructor specialization for 3d.

Parameters:
numPointsInEachDimensionnumber of Gauss points in each dimension

Definition at line 437 of file GaussianQuadratureRule.cpp.

References EXCEPTION.


Member Function Documentation

template<unsigned ELEMENT_DIM>
unsigned GaussianQuadratureRule< ELEMENT_DIM >::GetNumQuadPoints ( ) const

Get the number of quadrature points. This is the number of points in each dimension, raised to the power of the number of dimensions.

Definition at line 57 of file GaussianQuadratureRule.cpp.

Referenced by AbstractFunctionalCalculator< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM >::CalculateOnElement(), ElectrodesStimulusFactory< DIM >::ComputeElectrodeTotalFlux(), and QuadraturePointsGroup< DIM >::QuadraturePointsGroup().

template<unsigned ELEMENT_DIM>
double GaussianQuadratureRule< ELEMENT_DIM >::GetWeight ( unsigned  index) const

Get the weight associated with a quadrature point.

Parameters:
indexThe index of the point to return.

Definition at line 50 of file GaussianQuadratureRule.cpp.

Referenced by AbstractFunctionalCalculator< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM >::CalculateOnElement(), and ElectrodesStimulusFactory< DIM >::ComputeElectrodeTotalFlux().

template<unsigned ELEMENT_DIM>
const ChastePoint< ELEMENT_DIM > & GaussianQuadratureRule< ELEMENT_DIM >::rGetQuadPoint ( unsigned  index) const

Get a quadrature point.

Parameters:
indexThe index of the point to return.
Returns:
A gaussian quadrature point.

Definition at line 43 of file GaussianQuadratureRule.cpp.

Referenced by AbstractFunctionalCalculator< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM >::CalculateOnElement(), ElectrodesStimulusFactory< DIM >::ComputeElectrodeTotalFlux(), and QuadraturePointsGroup< DIM >::QuadraturePointsGroup().


Member Data Documentation

template<unsigned ELEMENT_DIM>
unsigned GaussianQuadratureRule< ELEMENT_DIM >::mNumQuadPoints [private]

The total number of Gauss points.

Definition at line 53 of file GaussianQuadratureRule.hpp.

Referenced by GaussianQuadratureRule< 1 >::GaussianQuadratureRule().

template<unsigned ELEMENT_DIM>
std::vector<ChastePoint<ELEMENT_DIM> > GaussianQuadratureRule< ELEMENT_DIM >::mPoints [private]

The gaussian quadrature points.

Definition at line 56 of file GaussianQuadratureRule.hpp.

Referenced by GaussianQuadratureRule< 1 >::GaussianQuadratureRule().

template<unsigned ELEMENT_DIM>
std::vector<double> GaussianQuadratureRule< ELEMENT_DIM >::mWeights [private]

The associated weights.

Definition at line 59 of file GaussianQuadratureRule.hpp.

Referenced by GaussianQuadratureRule< 1 >::GaussianQuadratureRule().


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