Thyra Version of the Day
Public Member Functions
Thyra::VectorSpaceFactoryBase< Scalar > Class Template Reference

Abstract interface for objects that can create vector spaces of a specified dimension. More...

#include <Thyra_VectorSpaceFactoryBase.hpp>

Inheritance diagram for Thyra::VectorSpaceFactoryBase< Scalar >:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual ~VectorSpaceFactoryBase ()
 

Public pure virtual functions that must be overridden

virtual RCP< const
VectorSpaceBase< Scalar > > 
createVecSpc (int dim) const =0
 Create a vector space of the given dimension.

Detailed Description

template<class Scalar>
class Thyra::VectorSpaceFactoryBase< Scalar >

Abstract interface for objects that can create vector spaces of a specified dimension.

The primary role that a VectorSpaceFactoryBase object takes is defined in the documentation for the class VectorSpaceBase and is related to the domain space of MultiVectorBase objects. However, this is a general factory interface class that can be used to create almost any VectorSpaceBase object just given a dimension.

Definition at line 62 of file Thyra_VectorSpaceFactoryBase.hpp.


Constructor & Destructor Documentation

template<class Scalar>
virtual Thyra::VectorSpaceFactoryBase< Scalar >::~VectorSpaceFactoryBase ( ) [inline, virtual]

Definition at line 66 of file Thyra_VectorSpaceFactoryBase.hpp.


Member Function Documentation

template<class Scalar>
virtual RCP< const VectorSpaceBase<Scalar> > Thyra::VectorSpaceFactoryBase< Scalar >::createVecSpc ( int  dim) const [pure virtual]

Create a vector space of the given dimension.

Parameters:
dim[in] The dimension of the vector space to create.

Preconditions:

  • dim > 0 (throw std::invalid_argument).

Postconditions:

  • return.get() != NULL
  • return->dim() == dim
Returns:
Returns a smart reference-counted pointer to a dynamically allocated vector space object that can be used to create vectors and multi-vectors.

Implemented in Thyra::DefaultSpmdVectorSpaceFactory< Scalar >.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines