AbstractStaticAssembler< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM, NON_HEART, CONCRETE > Class Template Reference

#include <AbstractStaticAssembler.hpp>

Inheritance diagram for AbstractStaticAssembler< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM, NON_HEART, CONCRETE >:

Collaboration diagram for AbstractStaticAssembler< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM, NON_HEART, CONCRETE >:

List of all members.

Public Member Functions

AbstractStaticAssembler (unsigned numQuadPoints=2)

void SetNumberOfQuadraturePointsPerDimension (unsigned numQuadPoints)

void SetMesh (AbstractMesh< ELEMENT_DIM, SPACE_DIM > *pMesh)

virtual ~AbstractStaticAssembler ()

Protected Types

typedef LinearBasisFunction
< ELEMENT_DIM > BasisFunction

typedef LinearBasisFunction
< ELEMENT_DIM-1 > SurfaceBasisFunction

Protected Member Functions

virtual void AssembleOnElement (Element< ELEMENT_DIM, SPACE_DIM > &rElement, c_matrix< double, PROBLEM_DIM *(ELEMENT_DIM+1), PROBLEM_DIM *(ELEMENT_DIM+1) > &rAElem, c_vector< double, PROBLEM_DIM *(ELEMENT_DIM+1)> &rBElem, bool assembleVector, bool assembleMatrix)

virtual void AssembleOnSurfaceElement (const BoundaryElement< ELEMENT_DIM-1, SPACE_DIM > &rSurfaceElement, c_vector< double, PROBLEM_DIM *ELEMENT_DIM > &rBSurfElem)

virtual void AssembleSystem (bool assembleVector, bool assembleMatrix, Vec currentSolutionOrGuess=NULL, double currentTime=0.0)

virtual void PrepareForSolve ()

LinearSystem ** GetLinearSystem ()

ReplicatableVector & rGetCurrentSolutionOrGuess ()

virtual double GetCurrentSolutionOrGuessValue (unsigned nodeIndex, unsigned indexOfUnknown)

Protected Attributes

AbstractMesh< ELEMENT_DIM,
SPACE_DIM > * mpMesh

GaussianQuadratureRule
< ELEMENT_DIM > * mpQuadRule

GaussianQuadratureRule
< ELEMENT_DIM-1 > * mpSurfaceQuadRule

ReplicatableVector mCurrentSolutionOrGuessReplicated

LinearSystem * mpLinearSystem

Detailed Description

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM, unsigned PROBLEM_DIM, bool NON_HEART, class CONCRETE>
class AbstractStaticAssembler< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM, NON_HEART, CONCRETE >

AbstractStaticAssembler

Implmentation of main assembler methods so that the virtual base class does not need to contain data (which should improve performance).

Templated over the PROBLEM_DIM so also handles problems with more than one unknown variable (ie those of the form u_xx + v = 0, v_xx + 2u = 1, where PROBLEM_DIM is equal to 2)

It defines default code for AssembleSystem, AssembleOnElement and AssembleOnSurfaceElement. Each of these work for any PROBLEM_DIM>=1. Each of these methods work in both the dynamic case (when there is a current solution available) and the static case. The same code is used for the nonlinear and linear cases

See also documentation for AbstractAssembler

Definition at line 101 of file AbstractStaticAssembler.hpp.

Member Typedef Documentation

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM, unsigned PROBLEM_DIM, bool NON_HEART, class CONCRETE>

typedef LinearBasisFunction<ELEMENT_DIM> AbstractStaticAssembler< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM, NON_HEART, CONCRETE >::BasisFunction [protected]

Basis function for use with normal elements

Definition at line 114 of file AbstractStaticAssembler.hpp.

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM, unsigned PROBLEM_DIM, bool NON_HEART, class CONCRETE>

typedef LinearBasisFunction<ELEMENT_DIM-1> AbstractStaticAssembler< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM, NON_HEART, CONCRETE >::SurfaceBasisFunction [protected]

Basis function for use with boundary elements

Definition at line 116 of file AbstractStaticAssembler.hpp.

Constructor & Destructor Documentation

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM, unsigned PROBLEM_DIM, bool NON_HEART, class CONCRETE>

AbstractStaticAssembler< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM, NON_HEART, CONCRETE >::AbstractStaticAssembler ( unsigned numQuadPoints = 2 ) [inline]

Default constructor. Uses linear basis functions.

Parameters:

numQuadPoints

Number of quadrature points to use per dimension.

Definition at line 598 of file AbstractStaticAssembler.hpp.

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM, unsigned PROBLEM_DIM, bool NON_HEART, class CONCRETE>

virtual AbstractStaticAssembler< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM, NON_HEART, CONCRETE >::~AbstractStaticAssembler ( ) [inline, virtual]

Delete any memory allocated by this class.

Definition at line 642 of file AbstractStaticAssembler.hpp.

Member Function Documentation

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM, unsigned PROBLEM_DIM, bool NON_HEART, class CONCRETE>

virtual void AbstractStaticAssembler< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM, NON_HEART, CONCRETE >::AssembleOnElement	(	Element< ELEMENT_DIM, SPACE_DIM > &	rElement,
		c_matrix< double, PROBLEM_DIM (ELEMENT_DIM+1), PROBLEM_DIM (ELEMENT_DIM+1) > &	rAElem,
		c_vector< double, PROBLEM_DIM *(ELEMENT_DIM+1)> &	rBElem,
		bool	assembleVector,
		bool	assembleMatrix
	)			`[inline, protected, virtual]`

Calculate the contribution of a single element to the linear system.

Parameters:

	rElement	The element to assemble on.
	rAElem	The element's contribution to the LHS matrix is returned in this n by n matrix, where n is the no. of nodes in this element. There is no need to zero this matrix before calling.
	rBElem	The element's contribution to the RHS vector is returned in this vector of length n, the no. of nodes in this element. There is no need to zero this vector before calling.
	currentSolutionOrGuess	For the parabolic linear case, the solution at the current timestep. NULL for the static linear case. In the nonlinear case, the current guess.
	assembleVector	a bool stating whether to assemble the load vector (in the linear case) or the residual vector (in the nonlinear case)
	assembleMatrix	a bool stating whether to assemble the stiffness matrix (in the linear case) or the Jacobian matrix (in the nonlinear case)

Called by AssembleSystem() Calls ComputeMatrixTerm() etc

Todo:: This assumes that the Jacobian is constant on an element. This is true for linear basis functions, but not for any other type of basis function.

Implements AbstractAssembler< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM >.

Definition at line 152 of file AbstractStaticAssembler.hpp.

Referenced by AbstractStaticAssembler< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM, NON_HEART, MonodomainRhsMatrixAssembler< DIM > >::AssembleSystem().

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM, unsigned PROBLEM_DIM, bool NON_HEART, class CONCRETE>

virtual void AbstractStaticAssembler< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM, NON_HEART, CONCRETE >::AssembleOnSurfaceElement	(	const BoundaryElement< ELEMENT_DIM-1, SPACE_DIM > &	rSurfaceElement,
		c_vector< double, PROBLEM_DIM *ELEMENT_DIM > &	rBSurfElem
	)			`[inline, protected, virtual]`

Calculate the contribution of a single surface element with Neumann boundary condition to the linear system.

Parameters:

	rSurfaceElement	The element to assemble on.
	rBSurfElem	The element's contribution to the RHS vector is returned in this vector of length n, the no. of nodes in this element. There is no need to zero this vector before calling.

Todo:: : add interpolation of u as well

Todo:: Improve efficiency of Neumann BC implementation.

Implements AbstractAssembler< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM >.

Definition at line 295 of file AbstractStaticAssembler.hpp.

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM, unsigned PROBLEM_DIM, bool NON_HEART, class CONCRETE>

virtual void AbstractStaticAssembler< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM, NON_HEART, CONCRETE >::AssembleSystem	(	bool	assembleVector,
		bool	assembleMatrix,
		Vec	currentSolutionOrGuess = `NULL`,
		double	currentTime = `0.0`
	)			`[inline, protected, virtual]`

AssembleSystem - the major method for all assemblers

Assemble the linear system for a linear PDE, or the residual or Jacobian for nonlinear PDEs. Loops over each element (and each each surface element if there are non-zero Neumann boundary conditions), calls AssembleOnElement() and adds the contribution to the linear system.

Takes in current solution and time if necessary but only used if the problem is a dynamic one. This method uses PROBLEM_DIM and can assemble linear systems for any number of unknown variables.

Called by Solve() Calls AssembleOnElement()

Parameters:

	assembleVector	Whether to assemble the RHS vector of the linear system (i.e. the residual vector for nonlinear problems).
	assembleMatrix	Whether to assemble the LHS matrix of the linear system (i.e. the jacobian matrix for nonlinear problems).
	currentSolutionOrGuess	The current solution in a linear dynamic problem, or the current guess in a nonlinear problem. Should be NULL for linear static problems.
	currentTime	The current time for dynamic problems. Not used in static problems.

Implements AbstractAssembler< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM >.

Reimplemented in AbstractNonlinearAssembler< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM, CONCRETE >, and AbstractNonlinearAssembler< ELEMENT_DIM, SPACE_DIM, 1, SimpleNonlinearEllipticAssembler< ELEMENT_DIM, SPACE_DIM > >.

Definition at line 378 of file AbstractStaticAssembler.hpp.

Referenced by AbstractLinearAssembler< DIM, DIM, 1, false, MonodomainRhsMatrixAssembler< DIM > >::StaticSolve().

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM, unsigned PROBLEM_DIM, bool NON_HEART, class CONCRETE>

virtual void AbstractStaticAssembler< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM, NON_HEART, CONCRETE >::PrepareForSolve ( ) [inline, protected, virtual]

This method is called at the beginning of Solve(). Subclass assemblers can use it to check everything has been set up correctly

Implements AbstractAssembler< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM >.

Definition at line 533 of file AbstractStaticAssembler.hpp.

Referenced by AbstractLinearAssembler< DIM, DIM, 1, false, MonodomainRhsMatrixAssembler< DIM > >::Solve().

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM, unsigned PROBLEM_DIM, bool NON_HEART, class CONCRETE>

LinearSystem** AbstractStaticAssembler< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM, NON_HEART, CONCRETE >::GetLinearSystem ( ) [inline, protected, virtual]

Accessor method that subclasses of AbstractAssembler (but not us) can use to get to useful data.

Implements AbstractAssembler< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM >.

Definition at line 570 of file AbstractStaticAssembler.hpp.

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM, unsigned PROBLEM_DIM, bool NON_HEART, class CONCRETE>

ReplicatableVector& AbstractStaticAssembler< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM, NON_HEART, CONCRETE >::rGetCurrentSolutionOrGuess ( ) [inline, protected, virtual]

Accessor method that subclasses of AbstractAssembler (but not us) can use to get to useful data.

Implements AbstractAssembler< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM >.

Definition at line 579 of file AbstractStaticAssembler.hpp.

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM, unsigned PROBLEM_DIM, bool NON_HEART, class CONCRETE>

virtual double AbstractStaticAssembler< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM, NON_HEART, CONCRETE >::GetCurrentSolutionOrGuessValue	(	unsigned	nodeIndex,
		unsigned	indexOfUnknown
	)			`[inline, protected, virtual]`

Get the value of the current solution (or guess) vector at the given node

Definition at line 587 of file AbstractStaticAssembler.hpp.

Referenced by AbstractStaticAssembler< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM, NON_HEART, MonodomainRhsMatrixAssembler< DIM > >::AssembleOnElement().

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM, unsigned PROBLEM_DIM, bool NON_HEART, class CONCRETE>

void AbstractStaticAssembler< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM, NON_HEART, CONCRETE >::SetNumberOfQuadraturePointsPerDimension ( unsigned numQuadPoints ) [inline]

Set the number of quadrature points to use, per dimension.

This method will throw an exception if the requested number of quadrature points is not supported. (///

Todo:: : There may be a small memory leak if this occurs.)

Parameters:

numQuadPoints

Number of quadrature points to use per dimension.

Definition at line 621 of file AbstractStaticAssembler.hpp.

Referenced by AbstractStaticAssembler< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM, NON_HEART, MonodomainRhsMatrixAssembler< DIM > >::AbstractStaticAssembler().

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM, unsigned PROBLEM_DIM, bool NON_HEART, class CONCRETE>

void AbstractStaticAssembler< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM, NON_HEART, CONCRETE >::SetMesh ( AbstractMesh< ELEMENT_DIM, SPACE_DIM > * pMesh ) [inline]

Set the mesh.

Definition at line 633 of file AbstractStaticAssembler.hpp.

Member Data Documentation

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM, unsigned PROBLEM_DIM, bool NON_HEART, class CONCRETE>

AbstractMesh<ELEMENT_DIM, SPACE_DIM>* AbstractStaticAssembler< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM, NON_HEART, CONCRETE >::mpMesh [protected]

Mesh to be solved on

Definition at line 105 of file AbstractStaticAssembler.hpp.

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM, unsigned PROBLEM_DIM, bool NON_HEART, class CONCRETE>

GaussianQuadratureRule<ELEMENT_DIM>* AbstractStaticAssembler< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM, NON_HEART, CONCRETE >::mpQuadRule [protected]

Quadrature rule for use on normal elements

Definition at line 108 of file AbstractStaticAssembler.hpp.

Referenced by AbstractStaticAssembler< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM, NON_HEART, MonodomainRhsMatrixAssembler< DIM > >::AbstractStaticAssembler(), AbstractStaticAssembler< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM, NON_HEART, MonodomainRhsMatrixAssembler< DIM > >::SetNumberOfQuadraturePointsPerDimension(), and AbstractStaticAssembler< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM, NON_HEART, MonodomainRhsMatrixAssembler< DIM > >::~AbstractStaticAssembler().

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM, unsigned PROBLEM_DIM, bool NON_HEART, class CONCRETE>

GaussianQuadratureRule<ELEMENT_DIM-1>* AbstractStaticAssembler< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM, NON_HEART, CONCRETE >::mpSurfaceQuadRule [protected]

Quadrature rule for use on boundary elements

Definition at line 110 of file AbstractStaticAssembler.hpp.

Referenced by AbstractStaticAssembler< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM, NON_HEART, MonodomainRhsMatrixAssembler< DIM > >::AbstractStaticAssembler(), AbstractStaticAssembler< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM, NON_HEART, MonodomainRhsMatrixAssembler< DIM > >::SetNumberOfQuadraturePointsPerDimension(), and AbstractStaticAssembler< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM, NON_HEART, MonodomainRhsMatrixAssembler< DIM > >::~AbstractStaticAssembler().

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM, unsigned PROBLEM_DIM, bool NON_HEART, class CONCRETE>

ReplicatableVector AbstractStaticAssembler< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM, NON_HEART, CONCRETE >::mCurrentSolutionOrGuessReplicated [protected]

The CURRENT SOLUTION as a replicated vector for linear dynamic problems. (Empty for a static problem). The CURRENT GUESS for nonlinear problems.

Definition at line 122 of file AbstractStaticAssembler.hpp.

Referenced by AbstractStaticAssembler< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM, NON_HEART, MonodomainRhsMatrixAssembler< DIM > >::AssembleOnElement(), AbstractStaticAssembler< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM, NON_HEART, MonodomainRhsMatrixAssembler< DIM > >::AssembleSystem(), AbstractStaticAssembler< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM, NON_HEART, MonodomainRhsMatrixAssembler< DIM > >::GetCurrentSolutionOrGuessValue(), and AbstractStaticAssembler< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM, NON_HEART, MonodomainRhsMatrixAssembler< DIM > >::rGetCurrentSolutionOrGuess().

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM, unsigned PROBLEM_DIM, bool NON_HEART, class CONCRETE>

LinearSystem* AbstractStaticAssembler< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM, NON_HEART, CONCRETE >::mpLinearSystem [protected]

The linear system that is assembled in linear pde problems. Not used in nonlinear problems

Definition at line 128 of file AbstractStaticAssembler.hpp.

Referenced by AbstractStaticAssembler< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM, NON_HEART, MonodomainRhsMatrixAssembler< DIM > >::AbstractStaticAssembler(), AbstractLinearAssembler< DIM, DIM, 1, false, MonodomainRhsMatrixAssembler< DIM > >::ApplyDirichletConditions(), AbstractStaticAssembler< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM, NON_HEART, MonodomainRhsMatrixAssembler< DIM > >::AssembleSystem(), AbstractStaticAssembler< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM, NON_HEART, MonodomainRhsMatrixAssembler< DIM > >::GetLinearSystem(), AbstractLinearAssembler< DIM, DIM, 1, false, MonodomainRhsMatrixAssembler< DIM > >::InitialiseForSolve(), AbstractLinearAssembler< DIM, DIM, 1, false, MonodomainRhsMatrixAssembler< DIM > >::StaticSolve(), and AbstractStaticAssembler< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM, NON_HEART, MonodomainRhsMatrixAssembler< DIM > >::~AbstractStaticAssembler().

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

/tmp/release_1/pde/src/solver/common/AbstractStaticAssembler.hpp


Public Member Functions
	AbstractStaticAssembler (unsigned numQuadPoints=2)
void	SetNumberOfQuadraturePointsPerDimension (unsigned numQuadPoints)
void	SetMesh (AbstractMesh< ELEMENT_DIM, SPACE_DIM > *pMesh)
virtual	~AbstractStaticAssembler ()
Protected Types
typedef LinearBasisFunction < ELEMENT_DIM >	BasisFunction
typedef LinearBasisFunction < ELEMENT_DIM-1 >	SurfaceBasisFunction
Protected Member Functions
virtual void	AssembleOnElement (Element< ELEMENT_DIM, SPACE_DIM > &rElement, c_matrix< double, PROBLEM_DIM (ELEMENT_DIM+1), PROBLEM_DIM (ELEMENT_DIM+1) > &rAElem, c_vector< double, PROBLEM_DIM *(ELEMENT_DIM+1)> &rBElem, bool assembleVector, bool assembleMatrix)
virtual void	AssembleOnSurfaceElement (const BoundaryElement< ELEMENT_DIM-1, SPACE_DIM > &rSurfaceElement, c_vector< double, PROBLEM_DIM *ELEMENT_DIM > &rBSurfElem)
virtual void	AssembleSystem (bool assembleVector, bool assembleMatrix, Vec currentSolutionOrGuess=NULL, double currentTime=0.0)
virtual void	PrepareForSolve ()
LinearSystem **	GetLinearSystem ()
ReplicatableVector &	rGetCurrentSolutionOrGuess ()
virtual double	GetCurrentSolutionOrGuessValue (unsigned nodeIndex, unsigned indexOfUnknown)
Protected Attributes
AbstractMesh< ELEMENT_DIM, SPACE_DIM > *	mpMesh
GaussianQuadratureRule < ELEMENT_DIM > *	mpQuadRule
GaussianQuadratureRule < ELEMENT_DIM-1 > *	mpSurfaceQuadRule
ReplicatableVector	mCurrentSolutionOrGuessReplicated
LinearSystem *	mpLinearSystem

AbstractStaticAssembler< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM, NON_HEART, CONCRETE > Class Template Reference

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM, unsigned PROBLEM_DIM, bool NON_HEART, class CONCRETE> class AbstractStaticAssembler< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM, NON_HEART, CONCRETE >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM, unsigned PROBLEM_DIM, bool NON_HEART, class CONCRETE>
class AbstractStaticAssembler< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM, NON_HEART, CONCRETE >