escript::AbstractContinuousDomain Class Reference

AbstractContinuousDomain, base class for continuous domains. More...

#include <AbstractContinuousDomain.h>

Inheritance diagram for escript::AbstractContinuousDomain:

List of all members.

Public Member Functions
	AbstractContinuousDomain ()
	Default constructor for AbstractContinuousDomain.
virtual	~AbstractContinuousDomain ()
	Destructor for AbstractContinuousDomain.
virtual bool	isValidFunctionSpaceType (int functionSpaceType) const
	Returns true if the given integer is a valid function space type for this domain.
virtual std::string	getDescription () const
	Return a description for this domain.
virtual int	getContinuousFunctionCode () const
	Return a continuous FunctionSpace code.
virtual int	getReducedContinuousFunctionCode () const
	Return a continuous on reduced order FunctionSpace code.
virtual int	getFunctionCode () const
	Return a function FunctionSpace code.
virtual int	getReducedFunctionCode () const
	Return a function FunctionSpace code with reduced integration order.
virtual int	getFunctionOnBoundaryCode () const
	Return a function on boundary FunctionSpace code.
virtual int	getReducedFunctionOnBoundaryCode () const
	Return a code for a function on boundary FunctionSpace with reduced integration order.
virtual int	getFunctionOnContactZeroCode () const
	Return a FunctionOnContactZero code.
virtual int	getReducedFunctionOnContactZeroCode () const
	Return a FunctionOnContactZero for reduced integration order code.
virtual int	getFunctionOnContactOneCode () const
	Return a FunctionOnContactOne code.
virtual int	getReducedFunctionOnContactOneCode () const
	Return a FunctionOnContactOne for reduced integration order code.
virtual int	getSolutionCode () const
	Return a Solution code.
virtual int	getReducedSolutionCode () const
	Return a ReducedSolution code.
virtual int	getDiracDeltaFunctionsCode () const
	Return a DiracDeltaFunctions code.
virtual int	getSystemMatrixTypeId (const int solver, const int preconditioner, const int package, const bool symmetry) const
	return the identifier of the matrix type to be used for the global stiffness matrix when a particular solver package and symmetric matrix is used.
virtual int	getTransportTypeId (const int solver, const int preconditioner, const int package, const bool symmetry) const
	return the identifier of the matrix type to be used for the global stiffness matrix when a particular solver package and symmetric matrix is used.
virtual void	setToIntegrals (std::vector< double > &integrals, const escript::Data &arg) const
	copies the integrals of the function defined by arg into integrals. arg has to be defined on this. has to be implemented by the Domain Adapter.
virtual void	addPDEToSystem (AbstractSystemMatrix &mat, escript::Data &rhs, const escript::Data &A, const escript::Data &B, const escript::Data &C, const escript::Data &D, const escript::Data &X, const escript::Data &Y, const escript::Data &d, const escript::Data &y, const escript::Data &d_contact, const escript::Data &y_contact, const escript::Data &d_dirac, const escript::Data &y_dirac) const
	Return the domain as const AbstractContinuousDomain&.
virtual void	addPDEToRHS (escript::Data &rhs, const escript::Data &X, const escript::Data &Y, const escript::Data &y, const escript::Data &y_contact, const escript::Data &y_dirac) const
	adds a PDE onto the lumped stiffness matrix matrix
virtual void	addPDEToTransportProblem (AbstractTransportProblem &tp, escript::Data &source, const escript::Data &M, const escript::Data &A, const escript::Data &B, const escript::Data &C, const escript::Data &D, const escript::Data &X, const escript::Data &Y, const escript::Data &d, const escript::Data &y, const escript::Data &d_contact, const escript::Data &y_contact, const escript::Data &d_dirac, const escript::Data &y_dirac) const
	adds a PDE onto a transport problem
virtual ASM_ptr	newSystemMatrix (const int row_blocksize, const escript::FunctionSpace &row_functionspace, const int column_blocksize, const escript::FunctionSpace &column_functionspace, const int type) const
	creates a SystemMatrixAdapter stiffness matrix and initializes it with zeros:
virtual ATP_ptr	newTransportProblem (const int blocksize, const escript::FunctionSpace &functionspace, const int type) const
	creates a TransportProblemAdapter
virtual int	getNumDataPointsGlobal () const
	Return the number of data points summed across all MPI processes.
virtual std::pair< int, int >	getDataShape (int functionSpaceCode) const
	Return the number of data points per sample, and the number of samples as a pair.
virtual void	setNewX (const escript::Data &arg)
	assigns new location to the domain
virtual void	Print_Mesh_Info (const bool full=false) const

---

Detailed Description

AbstractContinuousDomain, base class for continuous domains.

Description: AbstractContinuousDomain, base class for continuous domains.

NOTE: Most of the virtual functions would be pure virtual except boost.python requires a non abstract base class.

---

Constructor & Destructor Documentation

escript::AbstractContinuousDomain::AbstractContinuousDomain

(

)

Default constructor for AbstractContinuousDomain.

Description: Default constructor for AbstractContinuousDomain

Preconditions: Describe any preconditions

Throws: Describe any exceptions thrown

escript::AbstractContinuousDomain::~AbstractContinuousDomain

(

)

[virtual]

Destructor for AbstractContinuousDomain.

Description: Destructor for AbstractContinuousDomain

Preconditions: Describe any preconditions

Throws: Describe any exceptions thrown

---

Member Function Documentation

void escript::AbstractContinuousDomain::addPDEToRHS	(	escript::Data &	rhs,
		const escript::Data &	X,
		const escript::Data &	Y,
		const escript::Data &	y,
		const escript::Data &	y_contact,
		const escript::Data &	y_dirac
	)		const [virtual]

adds a PDE onto the lumped stiffness matrix matrix

adds a PDE onto the stiffness matrix mat and a rhs

Reimplemented in finley::MeshAdapter, dudley::MeshAdapter, and ripley::RipleyDomain.

Referenced by BOOST_PYTHON_MODULE().

void escript::AbstractContinuousDomain::addPDEToSystem	(	AbstractSystemMatrix &	mat,
		escript::Data &	rhs,
		const escript::Data &	A,
		const escript::Data &	B,
		const escript::Data &	C,
		const escript::Data &	D,
		const escript::Data &	X,
		const escript::Data &	Y,
		const escript::Data &	d,
		const escript::Data &	y,
		const escript::Data &	d_contact,
		const escript::Data &	y_contact,
		const escript::Data &	d_dirac,
		const escript::Data &	y_dirac
	)		const [virtual]

Return the domain as const AbstractContinuousDomain&.

adds a PDE onto the stiffness matrix mat and a rhs

Reimplemented in finley::MeshAdapter, dudley::MeshAdapter, and ripley::RipleyDomain.

Referenced by BOOST_PYTHON_MODULE().

void escript::AbstractContinuousDomain::addPDEToTransportProblem	(	AbstractTransportProblem &	tp,
		escript::Data &	source,
		const escript::Data &	M,
		const escript::Data &	A,
		const escript::Data &	B,
		const escript::Data &	C,
		const escript::Data &	D,
		const escript::Data &	X,
		const escript::Data &	Y,
		const escript::Data &	d,
		const escript::Data &	y,
		const escript::Data &	d_contact,
		const escript::Data &	y_contact,
		const escript::Data &	d_dirac,
		const escript::Data &	y_dirac
	)		const [virtual]

adds a PDE onto a transport problem

Reimplemented in finley::MeshAdapter, dudley::MeshAdapter, and ripley::RipleyDomain.

Referenced by BOOST_PYTHON_MODULE().

int escript::AbstractContinuousDomain::getContinuousFunctionCode

(

)

const [virtual]

Return a continuous FunctionSpace code.

Reimplemented in ripley::RipleyDomain, finley::MeshAdapter, and dudley::MeshAdapter.

std::pair< int, int > escript::AbstractContinuousDomain::getDataShape

(

int

functionSpaceCode

)

const [virtual]

Return the number of data points per sample, and the number of samples as a pair.

Parameters:

functionSpaceCode

Input -

Reimplemented from escript::AbstractDomain.

Reimplemented in finley::MeshAdapter, dudley::MeshAdapter, and ripley::RipleyDomain.

Referenced by BOOST_PYTHON_MODULE().

std::string escript::AbstractContinuousDomain::getDescription

(

)

const [virtual]

Return a description for this domain.

Reimplemented from escript::AbstractDomain.

Reimplemented in ripley::RipleyDomain, finley::MeshAdapter, dudley::MeshAdapter, ripley::Brick, and ripley::Rectangle.

Referenced by BOOST_PYTHON_MODULE().

int escript::AbstractContinuousDomain::getDiracDeltaFunctionsCode

(

)

const [virtual]

Return a DiracDeltaFunctions code.

Reimplemented in ripley::RipleyDomain, finley::MeshAdapter, and dudley::MeshAdapter.

int escript::AbstractContinuousDomain::getFunctionCode

(

)

const [virtual]

Return a function FunctionSpace code.

Reimplemented in ripley::RipleyDomain, finley::MeshAdapter, and dudley::MeshAdapter.

int escript::AbstractContinuousDomain::getFunctionOnBoundaryCode

(

)

const [virtual]

Return a function on boundary FunctionSpace code.

Reimplemented in ripley::RipleyDomain, finley::MeshAdapter, and dudley::MeshAdapter.

int escript::AbstractContinuousDomain::getFunctionOnContactOneCode

(

)

const [virtual]

Return a FunctionOnContactOne code.

Reimplemented in ripley::RipleyDomain, finley::MeshAdapter, and dudley::MeshAdapter.

int escript::AbstractContinuousDomain::getFunctionOnContactZeroCode

(

)

const [virtual]

Return a FunctionOnContactZero code.

Reimplemented in ripley::RipleyDomain, finley::MeshAdapter, and dudley::MeshAdapter.

int escript::AbstractContinuousDomain::getNumDataPointsGlobal

(

)

const [virtual]

Return the number of data points summed across all MPI processes.

Reimplemented in ripley::RipleyDomain, finley::MeshAdapter, dudley::MeshAdapter, ripley::Brick, and ripley::Rectangle.

Referenced by BOOST_PYTHON_MODULE().

int escript::AbstractContinuousDomain::getReducedContinuousFunctionCode

(

)

const [virtual]

Return a continuous on reduced order FunctionSpace code.

Reimplemented in ripley::RipleyDomain, finley::MeshAdapter, and dudley::MeshAdapter.

int escript::AbstractContinuousDomain::getReducedFunctionCode

(

)

const [virtual]

Return a function FunctionSpace code with reduced integration order.

Reimplemented in ripley::RipleyDomain, finley::MeshAdapter, and dudley::MeshAdapter.

int escript::AbstractContinuousDomain::getReducedFunctionOnBoundaryCode

(

)

const [virtual]

Return a code for a function on boundary FunctionSpace with reduced integration order.

Reimplemented in ripley::RipleyDomain, finley::MeshAdapter, and dudley::MeshAdapter.

int escript::AbstractContinuousDomain::getReducedFunctionOnContactOneCode

(

)

const [virtual]

Return a FunctionOnContactOne for reduced integration order code.

Reimplemented in ripley::RipleyDomain, finley::MeshAdapter, and dudley::MeshAdapter.

int escript::AbstractContinuousDomain::getReducedFunctionOnContactZeroCode

(

)

const [virtual]

Return a FunctionOnContactZero for reduced integration order code.

Reimplemented in ripley::RipleyDomain, finley::MeshAdapter, and dudley::MeshAdapter.

int escript::AbstractContinuousDomain::getReducedSolutionCode

(

)

const [virtual]

Return a ReducedSolution code.

Reimplemented in ripley::RipleyDomain, finley::MeshAdapter, and dudley::MeshAdapter.

int escript::AbstractContinuousDomain::getSolutionCode

(

)

const [virtual]

Return a Solution code.

Reimplemented in ripley::RipleyDomain, finley::MeshAdapter, and dudley::MeshAdapter.

int escript::AbstractContinuousDomain::getSystemMatrixTypeId	(	const int	solver,
		const int	preconditioner,
		const int	package,
		const bool	symmetry
	)		const [virtual]

return the identifier of the matrix type to be used for the global stiffness matrix when a particular solver package and symmetric matrix is used.

Reimplemented in finley::MeshAdapter, dudley::MeshAdapter, and ripley::RipleyDomain.

Referenced by BOOST_PYTHON_MODULE().

int escript::AbstractContinuousDomain::getTransportTypeId	(	const int	solver,
		const int	preconditioner,
		const int	package,
		const bool	symmetry
	)		const [virtual]

return the identifier of the matrix type to be used for the global stiffness matrix when a particular solver package and symmetric matrix is used.

Reimplemented in finley::MeshAdapter, dudley::MeshAdapter, and ripley::RipleyDomain.

Referenced by BOOST_PYTHON_MODULE().

bool escript::AbstractContinuousDomain::isValidFunctionSpaceType

(

int

functionSpaceType

)

const [virtual]

Returns true if the given integer is a valid function space type for this domain.

Reimplemented from escript::AbstractDomain.

Reimplemented in finley::MeshAdapter, dudley::MeshAdapter, and ripley::RipleyDomain.

ASM_ptr escript::AbstractContinuousDomain::newSystemMatrix	(	const int	row_blocksize,
		const escript::FunctionSpace &	row_functionspace,
		const int	column_blocksize,
		const escript::FunctionSpace &	column_functionspace,
		const int	type
	)		const [virtual]

creates a SystemMatrixAdapter stiffness matrix and initializes it with zeros:

Reimplemented in finley::MeshAdapter, dudley::MeshAdapter, and ripley::RipleyDomain.

Referenced by BOOST_PYTHON_MODULE().

ATP_ptr escript::AbstractContinuousDomain::newTransportProblem	(	const int	blocksize,
		const escript::FunctionSpace &	functionspace,
		const int	type
	)		const [virtual]

creates a TransportProblemAdapter

Reimplemented in finley::MeshAdapter, dudley::MeshAdapter, and ripley::RipleyDomain.

Referenced by BOOST_PYTHON_MODULE().

void escript::AbstractContinuousDomain::Print_Mesh_Info

(

const bool

full = false

)

const [virtual]

Parameters:

full

Reimplemented in ripley::RipleyDomain, finley::MeshAdapter, dudley::MeshAdapter, ripley::Brick, and ripley::Rectangle.

Referenced by BOOST_PYTHON_MODULE().

void escript::AbstractContinuousDomain::setNewX

(

const escript::Data &

arg

)

[virtual]

assigns new location to the domain

Reimplemented from escript::AbstractDomain.

Reimplemented in finley::MeshAdapter, dudley::MeshAdapter, and ripley::RipleyDomain.

Referenced by BOOST_PYTHON_MODULE().

void escript::AbstractContinuousDomain::setToIntegrals	(	std::vector< double > &	integrals,
		const escript::Data &	arg
	)		const [virtual]

copies the integrals of the function defined by arg into integrals. arg has to be defined on this. has to be implemented by the Domain Adapter.

Reimplemented in finley::MeshAdapter, ripley::RipleyDomain, and dudley::MeshAdapter.

Referenced by escript::Data::integrateWorker().

---

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

• AbstractContinuousDomain.h
• AbstractContinuousDomain.cpp