NullDomain provides a null value for domain. Needed for the construction of a default FunctionSpace. More...
#include <NullDomain.h>
Public Member Functions | |
| ESCRIPT_DLL_API | NullDomain () |
| Default constructor for NullDomain. | |
| virtual ESCRIPT_DLL_API bool | isValidFunctionSpaceType (int functionSpaceType) const |
| Returns true if the given integer is a valid function space type for this domain. | |
| virtual ESCRIPT_DLL_API std::string | getDescription () const |
| Return a description for this domain. | |
| virtual ESCRIPT_DLL_API std::string | functionSpaceTypeAsString (int functionSpaceType) const |
| Return a description for the given function space type code. | |
| virtual ESCRIPT_DLL_API void | interpolateOnDomain (escript::Data &target, const escript::Data &source) const |
| Interpolates data given on source onto target where source and target have to be given on the same domain. NullDomain only has one FunctionSpace so this makes target a shallow copy of source. | |
| virtual ESCRIPT_DLL_API bool | probeInterpolationOnDomain (int functionSpaceType_source, int functionSpaceType_target) const |
| virtual ESCRIPT_DLL_API void | interpolateACross (escript::Data &target, const escript::Data &source) const |
| Interpolates data given on source onto target where source and target are given on different domains. We do not permit interpolation into the NullDomain so this method always throws. | |
| virtual ESCRIPT_DLL_API bool | probeInterpolationACross (int functionSpaceType_source, const AbstractDomain &targetDomain, int functionSpaceType_target) const |
| virtual ESCRIPT_DLL_API int | getContinuousFunctionCode () const |
| Return a continuous FunctionSpace. | |
| virtual ESCRIPT_DLL_API int | getFunctionCode () const |
| Return a function FunctionSpace. | |
| virtual ESCRIPT_DLL_API int | getFunctionOnBoundaryCode () const |
| Return a function on boundary FunctionSpace. | |
| virtual ESCRIPT_DLL_API int | getFunctionOnContactZeroCode () const |
| Return a FunctionSpace. | |
| virtual ESCRIPT_DLL_API int | getFunctionOnContactOneCode () const |
| Return a FunctionSpace. | |
| virtual ESCRIPT_DLL_API int | getSolutionCode () const |
| Return a FunctionSpace. | |
| virtual ESCRIPT_DLL_API int | getReducedSolutionCode () const |
| Return a FunctionSpace. | |
| virtual ESCRIPT_DLL_API int | getDiracDeltaFunctionsCode () const |
| Return a FunctionSpace. | |
| virtual ESCRIPT_DLL_API 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 ESCRIPT_DLL_API int | getTagFromSampleNo (int functionSpaceType, int sampleNo) const |
| Return the tag key for the given sample number. | |
| virtual ESCRIPT_DLL_API const int * | borrowSampleReferenceIDs (int functionSpaceType) const |
| Return a borrowed pointer to the sample reference number id list. | |
| virtual ESCRIPT_DLL_API int | getDim () const |
| Returns the spatial dimension of the domain. | |
| virtual ESCRIPT_DLL_API bool | operator== (const AbstractDomain &other) const |
| Return true if given domains are equal. | |
| virtual ESCRIPT_DLL_API bool | operator!= (const AbstractDomain &other) const |
| virtual ESCRIPT_DLL_API bool | canTag (int functionSpaceCode) const |
| Checks if this domain allows tags for the specified functionSpaceCode. | |
| virtual ESCRIPT_DLL_API int | getNumberOfTagsInUse (int functionSpaceCode) const |
| return the number of tags in use. For this class the answer is always 1(the default tag). | |
| virtual ESCRIPT_DLL_API const int * | borrowListOfTagsInUse (int functionSpaceCode) const |
| returns a pointer to an array with the tags used. For this class the answer will always be {0} | |
| ESCRIPT_DLL_API bool | supportsContactElements () const |
Detailed Description
NullDomain provides a null value for domain. Needed for the construction of a default FunctionSpace.
Description: NullDomain provides a null value for domain. Needed for the construction of a default FunctionSpace. Inherits from AbstractDomain and overrides its methods. This domain supports a single type of FunctionSpace for which canTag is true. This compromise is needed to allow the default contructor of DataTagged to have a FunctionSpace which supports tagging. See notes on the borrowListOfTagsInUse() method.
Constructor & Destructor Documentation
| escript::NullDomain::NullDomain | ( | ) |
Default constructor for NullDomain.
Description: Default constructor for NullDomain.
Member Function Documentation
| const int * escript::NullDomain::borrowListOfTagsInUse | ( | int | functionSpaceCode | ) | const [virtual] |
returns a pointer to an array with the tags used. For this class the answer will always be {0}
Reimplemented from escript::AbstractDomain.
| const int * escript::NullDomain::borrowSampleReferenceIDs | ( | int | functionSpaceType | ) | const [virtual] |
Return a borrowed pointer to the sample reference number id list.
- Parameters:
-
functionSpaceType Input - The function space type.
Reimplemented from escript::AbstractDomain.
| bool escript::NullDomain::canTag | ( | int | functionSpaceCode | ) | const [virtual] |
Checks if this domain allows tags for the specified functionSpaceCode.
Reimplemented from escript::AbstractDomain.
| std::string escript::NullDomain::functionSpaceTypeAsString | ( | int | functionSpaceType | ) | const [virtual] |
Return a description for the given function space type code.
Reimplemented from escript::AbstractDomain.
| int escript::NullDomain::getContinuousFunctionCode | ( | ) | const [virtual] |
Return a continuous FunctionSpace.
| std::pair< int, int > escript::NullDomain::getDataShape | ( | int | functionSpaceCode | ) | const [virtual] |
Return the number of data points per sample, and the number of samples as a pair.
- Parameters:
-
functionSpaceCode Input - Code for the function space type.
- Returns:
- pair, first - number of data points per sample, second - number of samples
Reimplemented from escript::AbstractDomain.
| std::string escript::NullDomain::getDescription | ( | ) | const [virtual] |
Return a description for this domain.
Reimplemented from escript::AbstractDomain.
| int escript::NullDomain::getDim | ( | ) | const [virtual] |
Returns the spatial dimension of the domain.
This has to be implemented by the actual Domain adapter.
Reimplemented from escript::AbstractDomain.
| int escript::NullDomain::getDiracDeltaFunctionsCode | ( | ) | const [virtual] |
Return a FunctionSpace.
| int escript::NullDomain::getFunctionCode | ( | ) | const [virtual] |
Return a function FunctionSpace.
| int escript::NullDomain::getFunctionOnBoundaryCode | ( | ) | const [virtual] |
Return a function on boundary FunctionSpace.
| int escript::NullDomain::getFunctionOnContactOneCode | ( | ) | const [virtual] |
Return a FunctionSpace.
| int escript::NullDomain::getFunctionOnContactZeroCode | ( | ) | const [virtual] |
Return a FunctionSpace.
| int escript::NullDomain::getNumberOfTagsInUse | ( | int | functionSpaceCode | ) | const [virtual] |
return the number of tags in use. For this class the answer is always 1(the default tag).
Reimplemented from escript::AbstractDomain.
| int escript::NullDomain::getReducedSolutionCode | ( | ) | const [virtual] |
Return a FunctionSpace.
| int escript::NullDomain::getSolutionCode | ( | ) | const [virtual] |
Return a FunctionSpace.
| int escript::NullDomain::getTagFromSampleNo | ( | int | functionSpaceType, | |
| int | sampleNo | |||
| ) | const [virtual] |
Return the tag key for the given sample number.
- Parameters:
-
functionSpaceType Input - The function space type. sampleNo Input - The sample number.
Reimplemented from escript::AbstractDomain.
| void escript::NullDomain::interpolateACross | ( | escript::Data & | target, | |
| const escript::Data & | source | |||
| ) | const [virtual] |
Interpolates data given on source onto target where source and target are given on different domains. We do not permit interpolation into the NullDomain so this method always throws.
Reimplemented from escript::AbstractDomain.
| void escript::NullDomain::interpolateOnDomain | ( | escript::Data & | target, | |
| const escript::Data & | source | |||
| ) | const [virtual] |
Interpolates data given on source onto target where source and target have to be given on the same domain. NullDomain only has one FunctionSpace so this makes target a shallow copy of source.
Reimplemented from escript::AbstractDomain.
References escript::FunctionSpace::getDomain(), and escript::Data::getFunctionSpace().
| bool escript::NullDomain::isValidFunctionSpaceType | ( | int | functionSpaceType | ) | const [virtual] |
Returns true if the given integer is a valid function space type for this domain.
Reimplemented from escript::AbstractDomain.
| bool escript::NullDomain::operator!= | ( | const AbstractDomain & | other | ) | const [virtual] |
Reimplemented from escript::AbstractDomain.
| bool escript::NullDomain::operator== | ( | const AbstractDomain & | other | ) | const [virtual] |
Return true if given domains are equal.
Reimplemented from escript::AbstractDomain.
| bool escript::NullDomain::probeInterpolationACross | ( | int | functionSpaceType_source, | |
| const AbstractDomain & | targetDomain, | |||
| int | functionSpaceType_target | |||
| ) | const [virtual] |
Reimplemented from escript::AbstractDomain.
| bool escript::NullDomain::probeInterpolationOnDomain | ( | int | functionSpaceType_source, | |
| int | functionSpaceType_target | |||
| ) | const [virtual] |
Reimplemented from escript::AbstractDomain.
| bool escript::NullDomain::supportsContactElements | ( | ) | const [virtual] |
Reimplemented from escript::AbstractDomain.
The documentation for this class was generated from the following files:
Generated on Fri May 25 2012 00:38:58 for ESYS13 by
1.7.1