escript::FunctionSpace Class Reference

Give a short description of what FunctionSpace does. More...

#include <FunctionSpace.h>

List of all members.

Public Member Functions
ESCRIPT_DLL_API	FunctionSpace ()
	Default constructor for FunctionSpace.
ESCRIPT_DLL_API	FunctionSpace (const_Domain_ptr domain, int functionSpaceType)
	Constructor for FunctionSpace.
ESCRIPT_DLL_API	FunctionSpace (const FunctionSpace &other)
ESCRIPT_DLL_API int	getTypeCode () const
	Return the function space type code.
ESCRIPT_DLL_API const_Domain_ptr	getDomain () const
	Return the function space domain.
ESCRIPT_DLL_API Domain_ptr	getDomainPython () const
	Return the function space domain. Internal use only! This gets around some python difficulties by casting away the const. Do not use this in c++.
ESCRIPT_DLL_API bool	canTag () const
	Checks if this functionspace support tags.
ESCRIPT_DLL_API int	getApproximationOrder () const
	returns the approximation order used for this function space
ESCRIPT_DLL_API void	setTags (const int newTag, const escript::Data &mask) const
	assigns new tag newTag to all samples with a positive value of mask for any its sample point.
ESCRIPT_DLL_API void	setTagsByString (const std::string &name, const escript::Data &mask) const
ESCRIPT_DLL_API std::pair< int, int >	getDataShape () const
	Return the shape of the data needed to represent the function space.
ESCRIPT_DLL_API bool	operator== (const FunctionSpace &other) const
	Comparison operator. Return true if function spaces are equal. ie: Same domain and same function space type.
ESCRIPT_DLL_API bool	operator!= (const FunctionSpace &other) const
ESCRIPT_DLL_API std::string	toString () const
	Return a text description of the function space.
ESCRIPT_DLL_API int	getTagFromSampleNo (int sampleNo) const
	Return the tag associated with the given sample number.
ESCRIPT_DLL_API int	getTagFromDataPointNo (int dataPointNo) const
	Return the tag associated with the given data-point number.
ESCRIPT_DLL_API int	getReferenceIDFromDataPointNo (int dataPointNo) const
	Return the reference number associated with the given data-point number.
ESCRIPT_DLL_API int	getReferenceIDOfSample (int sampleNo) const
	Return the reference number associated with the given sample number. This function is not efficient. It is better to first call borrowSampleReferenceIDs and then when iterating over sampleNo to use sampleNo as an offset.
ESCRIPT_DLL_API bool	ownSample (int sampleNo) const
	Does this process own the sample? For non-MPI builds will always return true.
ESCRIPT_DLL_API const int *	borrowSampleReferenceIDs () const
	Return a borrowed reference to the list of sample reference IDs.
ESCRIPT_DLL_API escript::Data	getX () const
	Return the spatial locations of the data points.
ESCRIPT_DLL_API escript::Data	getNormal () const
	Return the surface normal field.
ESCRIPT_DLL_API escript::Data	getSize () const
	Return the sample size (e.g. the diameter of elements, radius of particles).
ESCRIPT_DLL_API int	getNumSamples () const
	Return the number of samples.
ESCRIPT_DLL_API int	getNumDPPSample () const
	Return the number of data points per sample.
ESCRIPT_DLL_API int	getNumDataPointsPerSample () const
ESCRIPT_DLL_API int	getDim () const
	Return the spatial dimension of the underlying domain.
ESCRIPT_DLL_API boost::python::list	getListOfTags () const
	Returns a list of the tags used in this function space.
ESCRIPT_DLL_API std::list< int >	getListOfTagsSTL () const
	Returns an stl::list of the tags used in this function space.
ESCRIPT_DLL_API int	getNumberOfTagsInUse () const
	return the number of tags in use and a pointer to an array with the number of tags in use
ESCRIPT_DLL_API const int *	borrowListOfTagsInUse () const
ESCRIPT_DLL_API bool	probeInterpolation (const FunctionSpace &other) const
Private Member Functions
ESCRIPT_DLL_API FunctionSpace &	operator= (const FunctionSpace &other)
	Assignment operator. This method is only defined (private) to prevent people from using it.
Private Attributes
const_Domain_ptr	m_domain
int	m_functionSpaceType

---

Detailed Description

Give a short description of what FunctionSpace does.

Description: Give a detailed description of FunctionSpace.

Template Parameters: For templates describe any conditions that the parameters used in the template must satisfy.

---

Constructor & Destructor Documentation

escript::FunctionSpace::FunctionSpace

(

)

Default constructor for FunctionSpace.

Description: Default constructor for FunctionSpace Generates a function space with a null domain.

Preconditions: Describe any preconditions.

Throws: Describe any exceptions thrown.

escript::FunctionSpace::FunctionSpace	(	const_Domain_ptr	domain,
		int	functionSpaceType
	)

Constructor for FunctionSpace.

Description: Constructor for FunctionSpace.

References m_domain.

escript::FunctionSpace::FunctionSpace

(

const FunctionSpace &

other

)

---

Member Function Documentation

const int * escript::FunctionSpace::borrowListOfTagsInUse

(

)

const

References m_domain, and m_functionSpaceType.

Referenced by getListOfTags(), and getListOfTagsSTL().

const int * escript::FunctionSpace::borrowSampleReferenceIDs

(

)

const

Return a borrowed reference to the list of sample reference IDs.

References m_domain, and m_functionSpaceType.

Referenced by escript::DataExpanded::dump(), getReferenceIDFromDataPointNo(), and getReferenceIDOfSample().

bool escript::FunctionSpace::canTag

(

)

const

Checks if this functionspace support tags.

References m_domain, and m_functionSpaceType.

Referenced by escript::DataTagged::DataTagged().

int escript::FunctionSpace::getApproximationOrder

(

)

const

returns the approximation order used for this function space

References m_domain, and m_functionSpaceType.

Referenced by BOOST_PYTHON_MODULE().

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

(

)

const

Return the shape of the data needed to represent the function space.

References m_domain, and m_functionSpaceType.

Referenced by getNumDataPointsPerSample(), and getNumSamples().

ESCRIPT_DLL_API int escript::FunctionSpace::getDim

(

)

const [inline]

Return the spatial dimension of the underlying domain.

References getDomain().

Referenced by BOOST_PYTHON_MODULE(), and escript::Data::gradOn().

const_Domain_ptr escript::FunctionSpace::getDomain

(

)

const

Return the function space domain.

References m_domain.

Referenced by escript::Data::Data(), escript::DataTagged::dump(), escript::DataExpanded::dump(), escript::DataConstant::dump(), getDim(), escript::Data::getDomain(), getNormal(), getSize(), getX(), escript::Data::gradOn(), finley::MeshAdapter::interpolateACross(), dudley::MeshAdapter::interpolateACross(), escript::TestDomain::interpolateOnDomain(), escript::NullDomain::interpolateOnDomain(), finley::MeshAdapter::interpolateOnDomain(), dudley::MeshAdapter::interpolateOnDomain(), finley::MeshAdapter::newSystemMatrix(), dudley::MeshAdapter::newSystemMatrix(), finley::MeshAdapter::newTransportProblem(), dudley::MeshAdapter::newTransportProblem(), probeInterpolation(), escript::DataExpanded::randomFill(), finley::MeshAdapter::setNewX(), dudley::MeshAdapter::setNewX(), escript::Data::setTaggedValueByName(), finley::MeshAdapter::setToGradient(), dudley::MeshAdapter::setToGradient(), finley::MeshAdapter::setToIntegrals(), dudley::MeshAdapter::setToIntegrals(), finley::MeshAdapter::setToNormal(), dudley::MeshAdapter::setToNormal(), finley::MeshAdapter::setToX(), and dudley::MeshAdapter::setToX().

Domain_ptr escript::FunctionSpace::getDomainPython

(

)

const

Return the function space domain. Internal use only! This gets around some python difficulties by casting away the const. Do not use this in c++.

References m_domain.

Referenced by BOOST_PYTHON_MODULE(), and escript::Data::getDomainPython().

boost::python::list escript::FunctionSpace::getListOfTags

(

)

const

Returns a list of the tags used in this function space.

References borrowListOfTagsInUse(), and getNumberOfTagsInUse().

Referenced by BOOST_PYTHON_MODULE().

std::list< int > escript::FunctionSpace::getListOfTagsSTL

(

)

const

Returns an stl::list of the tags used in this function space.

References borrowListOfTagsInUse(), and getNumberOfTagsInUse().

Referenced by escript::algorithm().

escript::Data escript::FunctionSpace::getNormal

(

)

const

Return the surface normal field.

References getDomain(), escript::Data::setProtection(), and escript::Vector().

Referenced by BOOST_PYTHON_MODULE(), finley::MeshAdapter::getNormal(), and dudley::MeshAdapter::getNormal().

int escript::FunctionSpace::getNumberOfTagsInUse

(

)

const

return the number of tags in use and a pointer to an array with the number of tags in use

References m_domain, and m_functionSpaceType.

Referenced by getListOfTags(), and getListOfTagsSTL().

ESCRIPT_DLL_API int escript::FunctionSpace::getNumDataPointsPerSample

(

)

const [inline]

References getDataShape().

Referenced by escript::DataExpanded::dump(), and getNumDPPSample().

ESCRIPT_DLL_API int escript::FunctionSpace::getNumDPPSample

(

)

const [inline]

Return the number of data points per sample.

References getNumDataPointsPerSample().

Referenced by escript::DataExpanded::DataExpanded(), getReferenceIDFromDataPointNo(), and getTagFromDataPointNo().

ESCRIPT_DLL_API int escript::FunctionSpace::getNumSamples

(

)

const [inline]

Return the number of samples.

References getDataShape().

Referenced by escript::DataExpanded::DataExpanded(), escript::DataExpanded::dump(), getReferenceIDFromDataPointNo(), and getTagFromDataPointNo().

int escript::FunctionSpace::getReferenceIDFromDataPointNo

(

int

dataPointNo

)

const

Return the reference number associated with the given data-point number.

References borrowSampleReferenceIDs(), getNumDPPSample(), and getNumSamples().

Referenced by BOOST_PYTHON_MODULE().

ESCRIPT_DLL_API int escript::FunctionSpace::getReferenceIDOfSample

(

int

sampleNo

)

const [inline]

Return the reference number associated with the given sample number. This function is not efficient. It is better to first call borrowSampleReferenceIDs and then when iterating over sampleNo to use sampleNo as an offset.

References borrowSampleReferenceIDs().

Referenced by escript::DataExpanded::reorderByReferenceIDs(), and escript::DataExpanded::toString().

escript::Data escript::FunctionSpace::getSize

(

)

const

Return the sample size (e.g. the diameter of elements, radius of particles).

References getDomain(), escript::Scalar(), and escript::Data::setProtection().

Referenced by BOOST_PYTHON_MODULE(), finley::MeshAdapter::getSize(), and dudley::MeshAdapter::getSize().

int escript::FunctionSpace::getTagFromDataPointNo

(

int

dataPointNo

)

const

Return the tag associated with the given data-point number.

References getNumDPPSample(), getNumSamples(), and getTagFromSampleNo().

Referenced by BOOST_PYTHON_MODULE(), and escript::Data::getTagNumber().

int escript::FunctionSpace::getTagFromSampleNo

(

int

sampleNo

)

const

Return the tag associated with the given sample number.

References m_domain, and m_functionSpaceType.

Referenced by escript::DataTagged::getPointOffset(), getTagFromDataPointNo(), and escript::DataTagged::getTagNumber().

int escript::FunctionSpace::getTypeCode

(

)

const

Return the function space type code.

Note: The meaning of the code depends on the domain object the FunctionSpace is built on.

References m_functionSpaceType.

Referenced by escript::DataTagged::dump(), escript::DataExpanded::dump(), escript::DataConstant::dump(), finley::MeshAdapter::interpolateOnDomain(), dudley::MeshAdapter::interpolateOnDomain(), finley::MeshAdapter::newSystemMatrix(), dudley::MeshAdapter::newSystemMatrix(), finley::MeshAdapter::newTransportProblem(), dudley::MeshAdapter::newTransportProblem(), probeInterpolation(), finley::MeshAdapter::setToGradient(), dudley::MeshAdapter::setToGradient(), finley::MeshAdapter::setToIntegrals(), dudley::MeshAdapter::setToIntegrals(), finley::MeshAdapter::setToNormal(), dudley::MeshAdapter::setToNormal(), finley::MeshAdapter::setToSize(), dudley::MeshAdapter::setToSize(), finley::MeshAdapter::setToX(), and dudley::MeshAdapter::setToX().

escript::Data escript::FunctionSpace::getX

(

)

const

Return the spatial locations of the data points.

References getDomain(), escript::Data::setProtection(), and escript::Vector().

Referenced by BOOST_PYTHON_MODULE(), finley::MeshAdapter::getX(), and dudley::MeshAdapter::getX().

bool escript::FunctionSpace::operator!=

(

const FunctionSpace &

other

)

const

References operator==().

FunctionSpace & escript::FunctionSpace::operator=

(

const FunctionSpace &

other

)

[private]

Assignment operator. This method is only defined (private) to prevent people from using it.

bool escript::FunctionSpace::operator==

(

const FunctionSpace &

other

)

const

Comparison operator. Return true if function spaces are equal. ie: Same domain and same function space type.

References m_domain, and m_functionSpaceType.

Referenced by operator!=().

ESCRIPT_DLL_API bool escript::FunctionSpace::ownSample

(

int

sampleNo

)

const [inline]

Does this process own the sample? For non-MPI builds will always return true.

References m_domain, and m_functionSpaceType.

ESCRIPT_DLL_API bool escript::FunctionSpace::probeInterpolation

(

const FunctionSpace &

other

)

const [inline]

References getDomain(), and getTypeCode().

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

void escript::FunctionSpace::setTags	(	const int	newTag,
		const escript::Data &	mask
	)			const

assigns new tag newTag to all samples with a positive value of mask for any its sample point.

References escript::Data::getFunctionSpace(), m_domain, and m_functionSpaceType.

Referenced by BOOST_PYTHON_MODULE().

void escript::FunctionSpace::setTagsByString	(	const std::string &	name,
		const escript::Data &	mask
	)			const

References escript::Data::getFunctionSpace(), m_domain, and m_functionSpaceType.

Referenced by BOOST_PYTHON_MODULE().

std::string escript::FunctionSpace::toString

(

)

const

Return a text description of the function space.

References m_domain, and m_functionSpaceType.

Referenced by BOOST_PYTHON_MODULE(), and escript::DataAbstract::operandCheck().

---

Member Data Documentation

const_Domain_ptr escript::FunctionSpace::m_domain [private]

Referenced by borrowListOfTagsInUse(), borrowSampleReferenceIDs(), canTag(), FunctionSpace(), getApproximationOrder(), getDataShape(), getDomain(), getDomainPython(), getNumberOfTagsInUse(), getTagFromSampleNo(), operator==(), ownSample(), setTags(), setTagsByString(), and toString().

int escript::FunctionSpace::m_functionSpaceType [private]

Referenced by borrowListOfTagsInUse(), borrowSampleReferenceIDs(), canTag(), getApproximationOrder(), getDataShape(), getNumberOfTagsInUse(), getTagFromSampleNo(), getTypeCode(), operator==(), ownSample(), setTags(), setTagsByString(), and toString().

---

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

• FunctionSpace.h
• FunctionSpace.cpp