Thyra Package Browser (Single Doxygen Collection)
Version of the Day
|
Classes | |
class | Thyra::DiagonalEpetraLinearOpWithSolveFactory |
Create a DefaultDiagonalLinearOpWithSolve out of a diagonal Epetra_RowMatrix object. More... | |
class | Thyra::EpetraLinearOp |
Concrete LinearOpBase adapter subclass for Epetra_Operator object. More... | |
class | Thyra::EpetraLinearOpBase |
Abstract base class for all LinearOpBase objects that can return an Epetra_Operator view of themselves and details about how to apply the view. More... | |
class | Thyra::EpetraOperatorViewExtractorBase |
Strategy interface for extracting an Epetra_Operator view out of a Thyra::LinearOpBase<double> object. More... | |
class | Thyra::EpetraOperatorViewExtractorStd |
Standard strategy subclass for extracting an Epetra_Operator view out of a Thyra::LinearOpBase<double> object by dynamic casting to the EpetraLinearOpBase interface. More... | |
class | Thyra::EpetraOperatorWrapper |
Implements the Epetra_Operator interface with a Thyra LinearOperator. More... | |
Enumerations | |
enum | Thyra::EAdjointEpetraOp { Thyra::EPETRA_OP_ADJOINT_SUPPORTED, Thyra::EPETRA_OP_ADJOINT_UNSUPPORTED } |
Determine if adjoints are supported on Epetra_Opeator or not. More... | |
enum | Thyra::EApplyEpetraOpAs { Thyra::EPETRA_OP_APPLY_APPLY, Thyra::EPETRA_OP_APPLY_APPLY_INVERSE } |
Determine how the apply an Epetra_Operator as a linear operator. More... | |
Functions | |
RCP< const Teuchos::Comm < Ordinal > > | Thyra::create_Comm (const RCP< const Epetra_Comm > &epetraComm) |
Given an Epetra_Comm object, return an equivalent Teuchos::Comm object. More... | |
RCP< const VectorSpaceBase < double > > | Thyra::create_VectorSpace (const RCP< const Epetra_Map > &epetra_map) |
Create an VectorSpaceBase object given an Epetra_Map object. More... | |
RCP< const VectorSpaceBase < double > > | Thyra::create_LocallyReplicatedVectorSpace (const RCP< const VectorSpaceBase< double > > &parentSpace, const int dim) |
Create a VectorSpaceBase object that creates locally replicated vector objects. More... | |
RCP< VectorBase< double > > | Thyra::create_Vector (const RCP< Epetra_Vector > &epetra_v, const RCP< const VectorSpaceBase< double > > &space=Teuchos::null) |
Create a non-const VectorBase object from a non-const Epetra_Vector object. More... | |
RCP< const VectorBase< double > > | Thyra::create_Vector (const RCP< const Epetra_Vector > &epetra_v, const RCP< const VectorSpaceBase< double > > &space=Teuchos::null) |
Create an const VectorBase wrapper object for a const Epetra_Vector object. More... | |
RCP< MultiVectorBase< double > > | Thyra::create_MultiVector (const RCP< Epetra_MultiVector > &epetra_mv, const RCP< const VectorSpaceBase< double > > &range=Teuchos::null, const RCP< const VectorSpaceBase< double > > &domain=Teuchos::null) |
Create a non-const MultiVectorBase object from a non-const Epetra_MultiVector object. More... | |
RCP< const MultiVectorBase < double > > | Thyra::create_MultiVector (const RCP< const Epetra_MultiVector > &epetra_mv, const RCP< const VectorSpaceBase< double > > &range=Teuchos::null, const RCP< const VectorSpaceBase< double > > &domain=Teuchos::null) |
Create an const MultiVectorBase wrapper object for a const Epetra_MultiVector object. More... | |
RCP< const Epetra_Comm > | Thyra::get_Epetra_Comm (const Teuchos::Comm< Ordinal > &comm) |
Get (or create) and Epetra_Comm given a Teuchos::Comm object. More... | |
RCP< const Epetra_Map > | Thyra::get_Epetra_Map (const VectorSpaceBase< double > &vs, const RCP< const Epetra_Comm > &comm) |
Get (or create) an Epetra_Map object given an VectorSpaceBase object an optionally an extra Epetra_Comm object. More... | |
RCP< Epetra_Vector > | Thyra::get_Epetra_Vector (const Epetra_Map &map, const RCP< VectorBase< double > > &v) |
Get a non-const Epetra_Vector view from a non-const VectorBase object if possible. More... | |
RCP< const Epetra_Vector > | Thyra::get_Epetra_Vector (const Epetra_Map &map, const RCP< const VectorBase< double > > &v) |
Get a const Epetra_Vector view from a const VectorBase object if possible. More... | |
RCP< Epetra_MultiVector > | Thyra::get_Epetra_MultiVector (const Epetra_Map &map, const RCP< MultiVectorBase< double > > &mv) |
Get a non-const Epetra_MultiVector view from a non-const MultiVectorBase object if possible. More... | |
RCP< const Epetra_MultiVector > | Thyra::get_Epetra_MultiVector (const Epetra_Map &map, const RCP< const MultiVectorBase< double > > &mv) |
Get a const Epetra_MultiVector view from a const MultiVectorBase object if possible. More... | |
Teuchos::RCP< Epetra_MultiVector > | Thyra::get_Epetra_MultiVector (const Epetra_Map &map, MultiVectorBase< double > &mv) |
Get a non-const Epetra_MultiVector view from a non-const MultiVectorBase object if possible where the client must maintain the memory of the input multivector. More... | |
Teuchos::RCP< const Epetra_MultiVector > | Thyra::get_Epetra_MultiVector (const Epetra_Map &map, const MultiVectorBase< double > &mv) |
Get a const Epetra_MultiVector view from a const MultiVectorBase object if possible where the client must maintain the memory of the input multivector. More... | |
const std::string | Thyra::toString (const EAdjointEpetraOp adjointEpetraOp) |
const std::string | Thyra::toString (const EApplyEpetraOpAs applyEpetraOpAs) |
template<class Scalar > | |
Teuchos::RCP< Epetra_Operator > | Thyra::get_Epetra_Operator (LinearOpBase< Scalar > &) |
Get smart pointer to non-const Epetra_Operator object from reference to a non-const EpetraLinearOp accessed through its LinearOpBase interface. More... | |
template<class Scalar > | |
Teuchos::RCP< const Epetra_Operator > | Thyra::get_Epetra_Operator (const LinearOpBase< Scalar > &) |
Get smart pointer to const Epetra_Operator object from reference to a const EpetraLinearOp accessed through its LinearOpBase interface. More... | |
The following functions and classes are used to create Thyra objects which wrap (or adapt) Epetra objects:
Thyra::create_VectorSpace()
accepts an Epetra_Map
object and returns a Thyra::VectorSpaceBase
object.
Thyra::create_Vector()
accepts an Epetra_Vector
object and returns a Thyra::VectorBase
object.
Thyra::create_MultiVector()
accepts an Epetra_MultiVector
object and returns a Thyra::MultiVectorBase
object.
Thyra::epetraLinearOp()
adapts an Epetra_Operator
object to form a Thyra::EpetraLinearOp
object.
The above adapter code is based directly from the general Thyra_Op_Vec_adapters_MPI_support_grp. Therefore these Epetra adapted objects are automatically compatible with any other such MPI-based SPMD adapter subclasses.
There is, however, one issue that requires a little care and that is using arbitrary Thyra::VectorBase
and Thyra::MultiVectorBase
objects with the vector and multi-vector versions of Thyra::EpetraLinearOp::apply()
. The issue is that the underlying Epetra_Operator::Apply()
function can only accept Epetra_MultiVector
objects. The utility functions Thyra::get_Epetra_MultiVector()
return an Epetra_MultiVector
view of any Thyra::MultiVectorBase
object with a compatible range space. Studying the implementations of these utility functions will show you how simple it is to provide for this type of interoperabiity. This type of interoperabiity machinary should also be used for other types of concrete adapter subclasses.
Other types of code will need to extract an Epetra_Vector
view of a Thyra::VectorBase
object. For this purpose the Thyra::get_Epetra_Vector()
functions are provided.
The utility functions Thyra::get_Epetra_Operator()
are also provided that encapsulate the extraction of an "adapted" Epetra_Operator
object out of a Thyra::EpetraLinearOp
object through its Thyra::LinearOpBase
base interface. This is a common type of activity in object-oriented programming.
Determine if adjoints are supported on Epetra_Opeator or not.
Enumerator | |
---|---|
EPETRA_OP_ADJOINT_SUPPORTED |
Adjoint supported. |
EPETRA_OP_ADJOINT_UNSUPPORTED |
Adjoint not supported. |
Definition at line 32 of file Thyra_EpetraTypes.hpp.
Determine how the apply an Epetra_Operator as a linear operator.
Enumerator | |
---|---|
EPETRA_OP_APPLY_APPLY |
Apply using Epetra_Operator::Apply(...) |
EPETRA_OP_APPLY_APPLY_INVERSE |
Apply using Epetra_Operator::ApplyInverse(...) |
Definition at line 61 of file Thyra_EpetraTypes.hpp.
Teuchos::RCP< const Teuchos::Comm< Thyra::Ordinal > > Thyra::create_Comm | ( | const RCP< const Epetra_Comm > & | epetraComm | ) |
Given an Epetra_Comm
object, return an equivalent Teuchos::Comm
object.
If a successful conversion could not be performed then return.get()==NULL
.
Definition at line 70 of file Thyra_EpetraThyraWrappers.cpp.
References Teuchos::RCP< T >::get(), Teuchos::null, rcp(), and Teuchos::rcp().
Referenced by Thyra::create_VectorSpace(), and main().
Teuchos::RCP< const Thyra::VectorSpaceBase< double > > Thyra::create_VectorSpace | ( | const RCP< const Epetra_Map > & | epetra_map | ) |
Create an VectorSpaceBase
object given an Epetra_Map
object.
epetra_map | [in] The Epetra map defining the partitioning of elements to processors. |
Preconditions:
epetra_map.get() != NULL
Postconditions:
return.get() != NULL
RCP
object epetra_map
is copied into the return
object and therefore a memory of epetra_map is kept. This uses an Epetra_Map
object to initialize a compatible VectorSpaceBase
object.
The fact that this function only accepts an Epetra_Map
object means that only maps that have elements of size one can be used to define a vector space. General Epetra_BlockMap
s can not be used. This is not a serious limitation since Epetra_Operator
's domain and range maps are of type Epetra_Map
.
This function works properly even if Epetra is not compiled with support for SPMD (i.e. HAVE_MPI
is not defined when compiling and linking). If SPMD support is not compiled into Epetra, then a serial implementation of the communication is used instead.
Definition at line 107 of file Thyra_EpetraThyraWrappers.cpp.
References Teuchos::as(), Thyra::create_Comm(), Teuchos::RCP< T >::get(), TEUCHOS_ASSERT_EQUALITY, and TEUCHOS_TEST_FOR_EXCEPTION.
Referenced by Thyra::EpetraLinearOp::allocateDomain(), Thyra::EpetraLinearOp::allocateRange(), Thyra::get_Epetra_MultiVector(), Thyra::get_Epetra_Vector(), Thyra::EpetraModelEvaluator::initialize(), Thyra::DiagonalEpetraLinearOpWithSolveFactory::initializeOp(), and main().
Teuchos::RCP< const Thyra::VectorSpaceBase< double > > Thyra::create_LocallyReplicatedVectorSpace | ( | const RCP< const VectorSpaceBase< double > > & | parentSpace, |
const int | dim | ||
) |
Create a VectorSpaceBase
object that creates locally replicated vector objects.
parentSpace | [in] The vector space that will be used to create the smaller locally-replicated vector space. |
dim | [in] The dimension of the locally replicated vector space. |
Note: This vector space will be compatible with the domain space of a multivector. which has the range space parentSpace
.
Definition at line 145 of file Thyra_EpetraThyraWrappers.cpp.
References Teuchos::dyn_cast(), and TEUCHOS_TEST_FOR_EXCEPT.
Referenced by Thyra::create_MultiVector().
Teuchos::RCP< Thyra::VectorBase< double > > Thyra::create_Vector | ( | const RCP< Epetra_Vector > & | epetra_v, |
const RCP< const VectorSpaceBase< double > > & | space = Teuchos::null |
||
) |
Create a non-const
VectorBase
object from a non-const
Epetra_Vector
object.
epetra_v | [in] Smart pointer to the Epetra_Vector object to wrap. |
space | [in] The vector space that is compatible with epetra_v->Map() . |
Precondiitions:
epetra_v.get()!=NULL
] space.get()!=NULL
Postconditions:
epetra_v.get()==NULL
] return.get()==NULL
[epetra_v.get()!=NULL
] return.get()!=NULL
RCP
object contains a copy of the input RCP<Epetra_Vector>
wrapped Epetra_Vector
object. It is also stated that *epetra_v
will only be guaranteed to be modifed after the last RCP
to the returned VectorBase
is destroyed. In addition, *return
is only valid as long as one RefCoutPtr
wrapper object still exits. Definition at line 161 of file Thyra_EpetraThyraWrappers.cpp.
References Teuchos::RCP< T >::get(), Teuchos::null, Teuchos::rcp(), and TEUCHOS_TEST_FOR_EXCEPT.
Referenced by Thyra::EpetraModelEvaluator::convertInArgsFromEpetraToThyra(), Thyra::DiagonalEpetraLinearOpWithSolveFactory::initializeOp(), and main().
Teuchos::RCP< const Thyra::VectorBase< double > > Thyra::create_Vector | ( | const RCP< const Epetra_Vector > & | epetra_v, |
const RCP< const VectorSpaceBase< double > > & | space = Teuchos::null |
||
) |
Create an const
VectorBase
wrapper object for a const
Epetra_Vector
object.
epetra_v | [in] Smart pointer to the Epetra_Vector object to wrap. |
space | [in] The vector space that is compatible with epetra_v->Map() . |
Precondiitions:
epetra_v.get()!=NULL
] space.get()!=NULL
Postconditions:
epetra_v.get()==NULL
] return.get()==NULL
[epetra_v.get()!=NULL
] return.get()!=NULL
RCP
object contains a copy of the input RCP<Epetra_Vector>
wrapped Epetra_Vector
object. In addition, *return
is only valid as long as one RefCoutPtr
wrapper object still exits. Definition at line 197 of file Thyra_EpetraThyraWrappers.cpp.
References Teuchos::RCP< T >::get(), Teuchos::null, Teuchos::rcp(), and TEUCHOS_TEST_FOR_EXCEPT.
Teuchos::RCP< Thyra::MultiVectorBase< double > > Thyra::create_MultiVector | ( | const RCP< Epetra_MultiVector > & | epetra_mv, |
const RCP< const VectorSpaceBase< double > > & | range = Teuchos::null , |
||
const RCP< const VectorSpaceBase< double > > & | domain = Teuchos::null |
||
) |
Create a non-const
MultiVectorBase
object from a non-const
Epetra_MultiVector
object.
epetra_mv | [in] Smart pointer to the Epetra_MultiVector object to wrap. |
range | [in] The vector space that is compatible with epetra_mv->Map() . |
domain | [in] The vector space that is compatible with epetra_mv.NumVectors . If domain.get()==NULL , then a space will be created internally. |
Precondiitions:
epetra_mv.get()!=NULL
range.get()!=NULL
RCP
object contains a copy of the input RCP<Epetra_MultiVector>
wrapped Epetra_MultiVector
object. It is also stated that *epetra_mv
will only be guaranteed to be modifed after the last RCP
to the returned MultiVectorBase
is destroyed. In addition, *return
is only valid as long as one RefCoutPtr
wrapper object still exits. Definition at line 233 of file Thyra_EpetraThyraWrappers.cpp.
References Thyra::create_LocallyReplicatedVectorSpace(), Teuchos::RCP< T >::get(), is_null(), Teuchos::null, Teuchos::rcp(), and TEUCHOS_TEST_FOR_EXCEPT.
Referenced by Thyra::EpetraLinearOp::applyImpl(), and main().
Teuchos::RCP< const Thyra::MultiVectorBase< double > > Thyra::create_MultiVector | ( | const RCP< const Epetra_MultiVector > & | epetra_mv, |
const RCP< const VectorSpaceBase< double > > & | range = Teuchos::null , |
||
const RCP< const VectorSpaceBase< double > > & | domain = Teuchos::null |
||
) |
Create an const
MultiVectorBase
wrapper object for a const
Epetra_MultiVector
object.
epetra_mv | [in] Smart pointer to the Epetra_MultiVector object to wrap. |
range | [in] The vector space that is compatible with epetra_mv->Map() . |
domain | [in] The vector space that is compatible with epetra_mv.NumVectors . If domain.get()==NULL , then a space will be created internally. |
Preconditions:
epetra_mv.get()!=NULL
range.get()!=NULL
RCP
object contains a copy of the input RCP<Epetra_MultiVector>
wrapped Epetra_MultiVector
object. In addition, *return
is only valid as long as one RefCoutPtr
wrapper object still exits. Definition at line 289 of file Thyra_EpetraThyraWrappers.cpp.
References Thyra::create_LocallyReplicatedVectorSpace(), Teuchos::RCP< T >::get(), is_null(), Teuchos::null, Teuchos::rcp(), and TEUCHOS_TEST_FOR_EXCEPT.
Teuchos::RCP< const Epetra_Comm > Thyra::get_Epetra_Comm | ( | const Teuchos::Comm< Ordinal > & | comm | ) |
Get (or create) and Epetra_Comm
given a Teuchos::Comm
object.
This function returns a new Epetra_Comm object from the input Teuchos::Comm object. If an Epetra_Comm was used to create this Tpetra::Comm object using the function create_Comm() then the Epetra_Comm object returned from this function will not be the same!
NOTE: The behavior of the implementation of this function is likely not the desired behavior and would likely surpise clients and is not consistent with the other functions that actually return the same Epetra object passed in.
Definition at line 345 of file Thyra_EpetraThyraWrappers.cpp.
References is_null(), nonnull(), rcp(), Teuchos::rcp(), and TEUCHOS_TEST_FOR_EXCEPTION.
Referenced by Thyra::EpetraOperatorWrapper::getEpetraComm().
Teuchos::RCP< const Epetra_Map > Thyra::get_Epetra_Map | ( | const VectorSpaceBase< double > & | vs, |
const RCP< const Epetra_Comm > & | comm | ||
) |
Get (or create) an Epetra_Map
object given an VectorSpaceBase
object an optionally an extra Epetra_Comm
object.
ToDo: Finish documentation!
Definition at line 399 of file Thyra_EpetraThyraWrappers.cpp.
References Teuchos::demangleName(), is_null(), nonnull(), Teuchos::rcp(), and TEUCHOS_TEST_FOR_EXCEPTION.
Referenced by Thyra::get_Epetra_Map(), and main().
Teuchos::RCP< Epetra_Vector > Thyra::get_Epetra_Vector | ( | const Epetra_Map & | map, |
const RCP< VectorBase< double > > & | v | ||
) |
Get a non-const
Epetra_Vector
view from a non-const
VectorBase
object if possible.
Preconditions:
v.get()!=NULL
map
must be compatible with *v.space()
If a RCP<Epetra_Vector>
object is already attached to the node of the smart pointer for mv
then this is returned directly. If not, then a view of the data in *v
is created and returned. In the latter case the smart pointer v
is copied and attached to the returned RCP object. Therefore, a temporary VectorBase
object can be created in the call to this function and the view in return
will persist until all of the RCP objects to the returned Epetra_Vector
object go away.
Note: the v
object is not guaranteed to be modified until the last smart pointer to the returned Epetra_Vector
object is destroyed.
Definition at line 506 of file Thyra_EpetraThyraWrappers.cpp.
References Thyra::create_VectorSpace(), is_null(), Teuchos::PRE_DESTROY, Teuchos::rcp(), and View.
Referenced by Thyra::EpetraModelEvaluator::convertInArgsFromThyraToEpetra(), Thyra::EpetraModelEvaluator::convertOutArgsFromThyraToEpetra(), Thyra::get_Epetra_Vector(), Thyra::EpetraLinearOp::getRowStatImpl(), main(), Thyra::EpetraLinearOp::scaleLeftImpl(), Thyra::EpetraLinearOp::scaleRightImpl(), Thyra::EpetraExtAddTransformer::transform(), Thyra::EpetraExtDiagScaledMatProdTransformer::transform(), and Thyra::EpetraExtDiagScalingTransformer::transform().
Teuchos::RCP< const Epetra_Vector > Thyra::get_Epetra_Vector | ( | const Epetra_Map & | map, |
const RCP< const VectorBase< double > > & | v | ||
) |
Get a const
Epetra_Vector
view from a const
VectorBase
object if possible.
Preconditions:
v.get()!=NULL
map
must be compatible with *v->space()
If a RCP<Epetra_Vector>
object is already attached to the node of the smart pointer for mv
then this is returned directly. If not, then a view of the data in *v
is created and returned. In the latter case the smart pointer v
is copied and attached to the returned RCP object. Therefore, a temporary VectorBase
object can be created in the call to this function and the view in return
will persist until all of the RCP objects to the returned Epetra_Vector
object go away.
Definition at line 613 of file Thyra_EpetraThyraWrappers.cpp.
References Thyra::create_VectorSpace(), is_null(), Teuchos::PRE_DESTROY, Teuchos::rcp(), and View.
Teuchos::RCP< Epetra_MultiVector > Thyra::get_Epetra_MultiVector | ( | const Epetra_Map & | map, |
const RCP< MultiVectorBase< double > > & | mv | ||
) |
Get a non-const
Epetra_MultiVector
view from a non-const
MultiVectorBase
object if possible.
Preconditions:
mv.get()!=NULL
map
must be compatible with *mv->range()
If a RCP<Epetra_MultiVector>
object is already attached to the node of the smart pointer for mv
then this is returned directly. If not, then a view of the data in *mv
is created and returned. In the latter case the smart pointer mv
is copied and attached to the returned RCP object. Therefore, a temporary MultiVectorBase
object can be created in the call to this function and the view in return
will persist until all of the RCP objects to the returned Epetra_MultiVector
object go away.
Note: the mv
object is not guaranteed to be modified until the last smart pointer to the returned Epetra_MultiVector
object is destroyed.
Definition at line 712 of file Thyra_EpetraThyraWrappers.cpp.
References Thyra::create_VectorSpace(), is_null(), Teuchos::PRE_DESTROY, Teuchos::rcp(), and View.
Referenced by Thyra::EpetraLinearOp::applyImpl(), Thyra::get_Epetra_MultiVector(), main(), and TEUCHOS_UNIT_TEST().
Teuchos::RCP< const Epetra_MultiVector > Thyra::get_Epetra_MultiVector | ( | const Epetra_Map & | map, |
const RCP< const MultiVectorBase< double > > & | mv | ||
) |
Get a const
Epetra_MultiVector
view from a const
MultiVectorBase
object if possible.
Preconditions:
mv.get()!=NULL
map
must be compatible with *mv.range()
If a RCP<const Epetra_MultiVector>
object is already attached to the node of the smart pointer for mv
then this is returned directly. If not, then a view of the data in *mv
is created and returned. In the latter case the smart pointer mv
is copied and attached to the returned RCP object. Therefore, a temporary MultiVectorBase
object can be created in the call to this function and the view in return
will persist until all of the RCP objects to the returned Epetra_MultiVector
object go away.
Definition at line 820 of file Thyra_EpetraThyraWrappers.cpp.
References Thyra::create_VectorSpace(), is_null(), Teuchos::PRE_DESTROY, Teuchos::rcp(), and View.
Teuchos::RCP< Epetra_MultiVector > Thyra::get_Epetra_MultiVector | ( | const Epetra_Map & | map, |
MultiVectorBase< double > & | mv | ||
) |
Get a non-const
Epetra_MultiVector
view from a non-const
MultiVectorBase
object if possible where the client must maintain the memory of the input multivector.
Preconditions:
map
must be compatible with *mv.range()
This function trys to dynamic cast some some known interfaces classes where data can be directly accessed and no RCP magic needs to be used. This results in improved performance in time-critical use cases (like when called for EpetraLinearOp
in the inner loop of a Krylov solver).
If this function can not dynamic cast to the direct data access interfaces it punts and calls the more general (but more expensive) get_Epetra_MultiVector()
function.
Note: the mv
object is not guaranteed to be modified until the last smart pointer to the returned Epetra_MultiVector
object is destroyed.
Definition at line 925 of file Thyra_EpetraThyraWrappers.cpp.
Teuchos::RCP< const Epetra_MultiVector > Thyra::get_Epetra_MultiVector | ( | const Epetra_Map & | map, |
const MultiVectorBase< double > & | mv | ||
) |
Get a const
Epetra_MultiVector
view from a const
MultiVectorBase
object if possible where the client must maintain the memory of the input multivector.
Preconditions:
map
must be compatible with *mv.range()
This function trys to dynamic cast some some known interfaces classes where data can be directly accessed and no RCP magic needs to be used. This results in improved performance in time-critical use cases (like when called for EpetraLinearOp
in the inner loop of a Krylov solver).
If this function can not dynamic cast to the direct data access interfaces it punts and calls the more general (but more expensive) get_Epetra_MultiVector()
function.
Definition at line 954 of file Thyra_EpetraThyraWrappers.cpp.
|
inline |
Definition at line 43 of file Thyra_EpetraTypes.hpp.
References Thyra::EPETRA_OP_ADJOINT_SUPPORTED, Thyra::EPETRA_OP_ADJOINT_UNSUPPORTED, TEUCHOS_TEST_FOR_EXCEPT, and TEUCHOS_UNREACHABLE_RETURN.
Referenced by Thyra::EpetraLinearOp::describe().
|
inline |
Definition at line 72 of file Thyra_EpetraTypes.hpp.
References Thyra::EPETRA_OP_APPLY_APPLY, Thyra::EPETRA_OP_APPLY_APPLY_INVERSE, TEUCHOS_TEST_FOR_EXCEPT, and TEUCHOS_UNREACHABLE_RETURN.
Teuchos::RCP<Epetra_Operator> Thyra::get_Epetra_Operator | ( | LinearOpBase< Scalar > & | ) |
Get smart pointer to non-const
Epetra_Operator
object from reference to a non-const
EpetraLinearOp
accessed through its LinearOpBase
interface.
op | [in] Reference to operator to extract Epetra_Operator out of. |
Preconditions:
dynamic_cast<EpetraLinearOp*>(&op) != NULL
This function is designed to provide an easy way for non-C++ experts to get at the Epetra_Operator
object that was stuck into an EpetraLinearOp
object.
If the dynamic cast fails then a std::bad_cast
exception is thrown containing a very detailed error message as to why the cast failed.
This function is simple enough and developers can see what needs to be done to accomplish this type of access by looking at the source code by clicking on:
Definition at line 48 of file Thyra_get_Epetra_Operator.hpp.
References TEUCHOS_TEST_FOR_EXCEPTION.
Teuchos::RCP<const Epetra_Operator> Thyra::get_Epetra_Operator | ( | const LinearOpBase< Scalar > & | ) |
Get smart pointer to const
Epetra_Operator
object from reference to a const
EpetraLinearOp
accessed through its LinearOpBase
interface.
op | [in] Reference to operator to extract Epetra_Operator out of. |
Preconditions:
dynamic_cast<const EpetraLinearOp*>(&op) != NULL
This function is designed to provide an easy way for non-C++ experts to get at the Epetra_Operator
object that was stuck into an EpetraLinearOp
object.
If the dynamic cast fails then a std::bad_cast
exception is thrown containing a very detailed error message as to why the cast failed.
This function is simple enough and developers can see what needs to be done to accomplish this type of access by looking at the source code by clicking on:
Definition at line 90 of file Thyra_get_Epetra_Operator.hpp.
References TEUCHOS_TEST_FOR_EXCEPTION.