Sundance::TestFunctionStub Class Reference

TestFunctionStub is the base class for unknown functions. More...

Inheritance diagram for Sundance::TestFunctionStub:

List of all members.

Public Member Functions
	TestFunctionStub (const std::string &name, int tensorOrder=0, int dim=1, const RCP< const TestFuncDataStub > &data=RCP< const TestFuncDataStub >())
	TestFunctionStub (const std::string &name, const SpectralBasis &sbasis, int tensorOrder=0, int dim=1, const RCP< const TestFuncDataStub > &data=RCP< const TestFuncDataStub >())
virtual	~TestFunctionStub ()
	virtual destructor
bool	isTestFunction () const
virtual RCP< ExprBase >	getRcp ()
	Return a safely-created RefCountPtr to the base type.
Protected Member Functions
const RCP< const TestFuncDataStub > &	dataStub () const
Private Attributes
RCP< const TestFuncDataStub >	data_

---

Detailed Description

TestFunctionStub is the base class for unknown functions.

Each framework will need to implement its own subclass of TestFunctionStub.

The interface is left very minimal so as to not place any constraints on how a framework might specify the basis. When a framework needs any information about the unknown function, it will have to get it by downcasting to the appropriate framework-specific subclass.

Writing a TestFunctionStub subclass

For purposes of interaction with the Sundance core, no additional methods are required. However, most frameworks will require extensions to TestFunctionStub that can supply the framework with information on the basis used by the unknown func. See the demo and standard frameworks for information on how to do this.

Definition at line 67 of file SundanceTestFunctionStub.hpp.

---

Constructor & Destructor Documentation

TestFunctionStub::TestFunctionStub	(	const std::string &	name,
		int	tensorOrder = 0,
		int	dim = 1,
		const RCP< const TestFuncDataStub > &	data = RCP<const TestFuncDataStub>()
	)

Definition at line 45 of file SundanceTestFunctionStub.cpp.

References Sundance::ListExpr::append(), Sundance::FunctionIdentifier::createComponent(), Sundance::FunctionWithID::fid(), and Sundance::ExprBase::toString().

TestFunctionStub::TestFunctionStub	(	const std::string &	name,
		const SpectralBasis &	sbasis,
		int	tensorOrder = 0,
		int	dim = 1,
		const RCP< const TestFuncDataStub > &	data = RCP<const TestFuncDataStub>()
	)

Definition at line 73 of file SundanceTestFunctionStub.cpp.

References Sundance::ListExpr::append(), Sundance::FunctionIdentifier::createComponent(), Sundance::FunctionWithID::fid(), Sundance::makeFuncID(), Sundance::ExprBase::toString(), and Teuchos::toString().

virtual Sundance::TestFunctionStub::~TestFunctionStub

(

)

[inline, virtual]

virtual destructor

Definition at line 81 of file SundanceTestFunctionStub.hpp.

---

Member Function Documentation

const RCP<const TestFuncDataStub>& Sundance::TestFunctionStub::dataStub

(

)

const [inline, protected]

Definition at line 92 of file SundanceTestFunctionStub.hpp.

References data_.

virtual RCP<ExprBase> Sundance::TestFunctionStub::getRcp

(

)

[inline, virtual]

Return a safely-created RefCountPtr to the base type.

Reimplemented from Sundance::ListExpr.

Definition at line 87 of file SundanceTestFunctionStub.hpp.

bool Sundance::TestFunctionStub::isTestFunction

(

)

const [inline, virtual]

Reimplemented from Sundance::SymbolicFuncDescriptor.

Definition at line 84 of file SundanceTestFunctionStub.hpp.

---

Member Data Documentation

RCP<const TestFuncDataStub> Sundance::TestFunctionStub::data_ [private]

Definition at line 95 of file SundanceTestFunctionStub.hpp.

Referenced by dataStub().