Sundance::UnknownFunctionStub Class Reference

Inheritance diagram for Sundance::UnknownFunctionStub:

List of all members.

Public Member Functions
	UnknownFunctionStub (const std::string &name, int tensorOrder=0, int dim=1, const RCP< const UnknownFuncDataStub > &data=RCP< const UnknownFuncDataStub >())
	UnknownFunctionStub (const std::string &name, const SpectralBasis &sbasis, int tensorOrder=0, int dim=1, const RCP< const UnknownFuncDataStub > &data=RCP< const UnknownFuncDataStub >())
virtual	~UnknownFunctionStub ()
bool	isUnknownFunction () const
virtual RCP< ExprBase >	getRcp ()
Protected Member Functions
const RCP< const UnknownFuncDataStub > &	dataStub () const
Private Attributes
RCP< const UnknownFuncDataStub >	data_

---

Detailed Description

UnknownFunctionStub is the base class for unknown functions. Each framework will need to implement its own subclass of UnknownFunctionStub.

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 UnknownFunctionStub subclass

For purposes of interaction with the Sundance core, no additional methods are required. However, most frameworks will require extensions to UnknownFunctionStub 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 64 of file SundanceUnknownFunctionStub.hpp.

---

Constructor & Destructor Documentation

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

Definition at line 45 of file SundanceUnknownFunctionStub.cpp.

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

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

Definition at line 76 of file SundanceUnknownFunctionStub.cpp.

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

virtual Sundance::UnknownFunctionStub::~UnknownFunctionStub

(

)

[inline, virtual]

virtual destructor

Definition at line 78 of file SundanceUnknownFunctionStub.hpp.

---

Member Function Documentation

const RCP<const UnknownFuncDataStub>& Sundance::UnknownFunctionStub::dataStub

(

)

const [inline, protected]

Definition at line 89 of file SundanceUnknownFunctionStub.hpp.

References data_.

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

(

)

[inline, virtual]

Reimplemented from Sundance::ListExpr.

Definition at line 84 of file SundanceUnknownFunctionStub.hpp.

bool Sundance::UnknownFunctionStub::isUnknownFunction

(

)

const [inline, virtual]

Reimplemented from Sundance::SymbolicFuncDescriptor.

Definition at line 81 of file SundanceUnknownFunctionStub.hpp.

---

Member Data Documentation

RCP<const UnknownFuncDataStub> Sundance::UnknownFunctionStub::data_ [private]

Definition at line 92 of file SundanceUnknownFunctionStub.hpp.

Referenced by dataStub().