Class Sundance::Handle provides a general implementation of the common features of reference-counted handles. More...
Public Member Functions | |
| Handle () | |
| Empty ctor. | |
| Handle (const RCP< PointerType > &_ptr) | |
| Construct from a smart pointer. | |
| Handle (Handleable< PointerType > *rawPtr) | |
| Construct from a raw pointer to a Handleable. | |
| const RCP< PointerType > & | ptr () const |
| Read-only access to the underlying smart pointer. | |
| RCP< PointerType > & | ptr () |
| Read-write access to the underlying smart pointer. | |
| void | print (std::ostream &os) const |
| Print to a stream using the Printable interface. | |
| std::string | description () const |
| Return a short descriptive std::string using the Describable interface. | |
| void | setName (const std::string &name) |
| std::string | name () const |
| int | verb () const |
| Return the verbosity setting using the ObjectWithVerbosity interface. | |
| void | setVerbosity (int x) |
| Set the verbosity level of the object using the ObjectWithVerbosity interface. | |
| std::string | fallbackDescription () const |
| Write a fallback description to be used in objects that are neither named, printable, or describable. | |
Private Attributes | |
| RCP< PointerType > | ptr_ |
Detailed Description
template<class PointerType>
class Sundance::Handle< PointerType >
Class Sundance::Handle provides a general implementation of the common features of reference-counted handles.
Definition at line 95 of file SundanceHandle.hpp.
Constructor & Destructor Documentation
| Sundance::Handle< PointerType >::Handle | ( | ) | [inline] |
Empty ctor.
Definition at line 99 of file SundanceHandle.hpp.
| Sundance::Handle< PointerType >::Handle | ( | const RCP< PointerType > & | _ptr | ) | [inline] |
Construct from a smart pointer.
Definition at line 102 of file SundanceHandle.hpp.
| Sundance::Handle< PointerType >::Handle | ( | Handleable< PointerType > * | rawPtr | ) | [inline] |
Construct from a raw pointer to a Handleable.
Definition at line 105 of file SundanceHandle.hpp.
Member Function Documentation
| std::string Sundance::Handle< PointerType >::description | ( | ) | const [inline] |
Return a short descriptive std::string using the Describable interface.
If the contents of the handle cannot be downcasted or crosscasted to a Describable*, an exception will be thrown.
Reimplemented in Sundance::CellPredicate, TSFExtended::Vector< Scalar >, and TSFExtended::Vector< double >.
Definition at line 237 of file SundanceHandle.hpp.
References Sundance::NamedObject::name(), and Sundance::ObjectWithVerbosityBase::verb().
Referenced by TSFExtended::EpetraVectorType::createGhostImporter(), Sundance::SubsetCellFilter::description(), Sundance::LabeledSubsetCellFilter::description(), and Sundance::SubsetCellFilter::SubsetCellFilter().
| std::string Sundance::Handle< PointerType >::fallbackDescription | ( | ) | const [inline] |
Write a fallback description to be used in objects that are neither named, printable, or describable.
Definition at line 269 of file SundanceHandle.hpp.
| std::string Sundance::Handle< PointerType >::name | ( | ) | const [inline] |
Definition at line 138 of file SundanceHandle.hpp.
| void Sundance::Handle< PointerType >::print | ( | std::ostream & | os | ) | const [inline] |
Print to a stream using the Printable interface.
If the contents of the handle cannot be downcasted or crosscasted to a Printable*, an exception will be thrown
Reimplemented in TSFExtended::Vector< Scalar >, and TSFExtended::Vector< double >.
Definition at line 197 of file SundanceHandle.hpp.
References Sundance::NamedObject::name(), Sundance::Printable::print(), and Sundance::ObjectWithVerbosityBase::verb().
Referenced by Sundance::Assembler::assemble(), TSFExtended::NonlinearOperatorBase< double >::getJacobian(), Projection1DTest::name(), Poisson1DTest::name(), std::operator<<(), Sundance::Handle< QuadratureFamilyStub >::setVerbosity(), and Sundance::LinearSolveDriver::solve().
| RCP<PointerType>& Sundance::Handle< PointerType >::ptr | ( | ) | [inline] |
Read-write access to the underlying smart pointer.
Definition at line 111 of file SundanceHandle.hpp.
| const RCP<PointerType>& Sundance::Handle< PointerType >::ptr | ( | ) | const [inline] |
Read-only access to the underlying smart pointer.
Definition at line 108 of file SundanceHandle.hpp.
Referenced by Sundance::FieldWriter::addField(), Sundance::FunctionalPolynomial::addPoly(), Sundance::HomogeneousDOFMap::allocate(), Epetra::Epetra_TSFOperator::Apply(), Epetra::Epetra_TSFOperator::ApplyInverse(), Sundance::basisRestrictableToBoundary(), Sundance::CFMeshPair::CFMeshPair(), Sundance::SymbolicTransformation::chooseSign(), Sundance::Complex(), Sundance::NLOp::computeFunctionValue(), Sundance::NLOp::computeJacobianAndFunction(), Sundance::NLOp::computeSensitivities(), Sundance::Assembler::configureVectorBlock(), TSFExtended::SerialVectorType::createGhostImporter(), TSFExtended::EpetraVectorType::createGhostImporter(), TSFExtended::SerialVectorType::createMatrixFactory(), TSFExtended::EpetraVectorType::createMatrixFactory(), Sundance::MeshSourceBase::createMesh(), TSFExtended::denseSolve(), TSFExtended::denseSVD(), Sundance::describeFunction(), Sundance::DiscreteFunction::discFunc(), Sundance::Expr::divide(), Epetra::Epetra_TSFOperator::Epetra_TSFOperator(), TSFExtended::epetraLeftScale(), TSFExtended::epetraMatrixMatrixProduct(), TSFExtended::epetraMatrixMatrixSum(), TSFExtended::epetraRightScale(), Sundance::ExprFieldWrapper::ExprFieldWrapper(), Sundance::PeanoMesher3D::fillMesh(), Sundance::PeanoMesher2D::fillMesh(), Sundance::HNMesher3D::fillMesh(), Sundance::HNMesher2D::fillMesh(), Sundance::FunctionSupportResolver::flattenSpectral(), Sundance::EquationSet::flattenSpectral(), Sundance::SumOfIntegrals::funcsOnRegion(), Sundance::FunctionalPolynomial::FunctionalPolynomial(), Sundance::FunctionSupportResolver::FunctionSupportResolver(), Sundance::BasisFamily::getBasisTopology(), TSFExtended::getComm(), TSFExtended::SerialVector::getConcrete(), TSFExtended::EpetraVector::getConcrete(), TSFExtended::EpetraMatrix::getConcrete(), TSFExtended::EpetraVector::getConcretePtr(), TSFExtended::EpetraMatrix::getConcretePtr(), Sundance::EvaluatableExpr::getEvalExpr(), Sundance::DOFMapBuilder::getMaxCellFilter(), Sundance::VectorBasisComponent::getReferenceDOFs(), Sundance::SymbolicTransformation::getScalar(), Sundance::UserDefOp::getScalarArgs(), TSFExtended::SerialGhostImporter::importView(), Sundance::MatrixVectorAssemblyKernel::init(), Sundance::DiscreteSpace::initImporter(), Sundance::SubsetCellFilter::internalGetCells(), Sundance::CFMeshPair::isEmpty(), Sundance::SymbolicFuncElement::isIndependentOf(), Sundance::SymbolicFuncElement::isLinearForm(), Sundance::DOFMapBuilder::isWholeDomain(), Sundance::Expr::lessThan(), Sundance::makeDeriv(), Sundance::LinearEigenproblem::makeEigenfunctions(), TSFExtended::makeEpetraDiagonalMatrix(), Sundance::LinearEigenproblem::makeMassProb(), TSFExtended::InitTraits< MultiVectorBase< double >, LinearOpBase< double > >::makeMV(), Sundance::Expr::multiply(), Sundance::FunctionalPolynomial::multiplyPoly(), Sundance::FunctionalPolynomial::multiplyScalar(), Sundance::NLOp::NLOp(), TSFExtended::NOXSolver::NOXSolver(), Sundance::VectorBasisComponent::nReferenceDOFsWithFacets(), Sundance::VectorBasisComponent::nReferenceDOFsWithoutFacets(), Sundance::OrderedHandle< CellFilterStub >::operator<(), Sundance::CellSet::operator<(), Sundance::CellPredicate::operator<(), Sundance::Expr::operator<<(), Sundance::operator<<(), Sundance::Expr::operator[](), TSFExtended::InitTraits< MultiVectorBase< double >, LinearOpBase< double > >::opPtr(), TSFExtended::InitTraits< SimpleMV, LinearOperator< double > >::opPtr(), Sundance::pow(), Sundance::SymbPreprocessor::processInputFuncs(), Sundance::SymbPreprocessor::processInputParams(), Sundance::VectorBasisComponent::refEval(), Sundance::SymbPreprocessor::setupVariations(), TSFExtended::BelosSolver::solve(), Sundance::LinearSolveDriver::solve(), Sundance::SymbolicFunc::substituteZero(), Sundance::Expr::sum(), Sundance::VectorBasisComponent::supportsCellTypePair(), Sundance::DOFMapBuilder::testCellFilters(), TSFExtended::tsfVectorSpace2EpetraMap(), Sundance::unfoldPeriodicMesh(), Sundance::DOFMapBuilder::unkCellFilters(), Sundance::VectorBasisComponent::VectorBasisComponent(), and Sundance::VectorFillingAssemblyKernel::VectorFillingAssemblyKernel().
| void Sundance::Handle< PointerType >::setName | ( | const std::string & | name | ) | [inline] |
Reimplemented in Sundance::CellFilter.
Definition at line 131 of file SundanceHandle.hpp.
Referenced by TSFExtended::PCDPreconditionerFactory::createPreconditioner().
| void Sundance::Handle< PointerType >::setVerbosity | ( | int | x | ) | [inline, virtual] |
Set the verbosity level of the object using the ObjectWithVerbosity interface.
If the contents of the handle cannot be downcasted or crosscasted into an ObjectWithVerbosity, this call will be ignored and a warning printed.
Implements Sundance::ObjectWithVerbosityBase.
Definition at line 166 of file SundanceHandle.hpp.
| int Sundance::Handle< PointerType >::verb | ( | ) | const [inline, virtual] |
Return the verbosity setting using the ObjectWithVerbosity interface.
If the contents of the handle cannot be downcasted or crosscasted into an ObjectWithVerbosity, a value of zero will be returned.
Implements Sundance::ObjectWithVerbosityBase.
Definition at line 151 of file SundanceHandle.hpp.
Referenced by Sundance::CellIterator::CellIterator().
Member Data Documentation
RCP<PointerType> Sundance::Handle< PointerType >::ptr_ [private] |
Definition at line 192 of file SundanceHandle.hpp.
Referenced by Sundance::Handle< QuadratureFamilyStub >::name(), Sundance::Handle< QuadratureFamilyStub >::ptr(), Sundance::Handle< QuadratureFamilyStub >::setName(), Sundance::Handle< QuadratureFamilyStub >::setVerbosity(), and Sundance::Handle< QuadratureFamilyStub >::verb().