Thyra_EpetraThyraWrappers.hpp

Go to the documentation of this file.

// @HEADER
// ***********************************************************************
// 
//    Thyra: Interfaces and Support for Abstract Numerical Algorithms
//                 Copyright (2004) Sandia Corporation
// 
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
// 
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Roscoe A. Bartlett (bartlettra@ornl.gov) 
// 
// ***********************************************************************
// @HEADER

#ifndef THYRA_EPETRA_THYRA_WRAPPERS_HPP
#define THYRA_EPETRA_THYRA_WRAPPERS_HPP


#include "Thyra_EpetraTypes.hpp"


namespace Teuchos { template<class Ordinal> class Comm; }


namespace Thyra {


RCP<const Teuchos::Comm<Ordinal> >
create_Comm( const RCP<const Epetra_Comm> &epetraComm );


RCP<const VectorSpaceBase<double> >
create_VectorSpace(
  const RCP<const Epetra_Map> &epetra_map
  );


RCP<const VectorSpaceBase<double> >
create_LocallyReplicatedVectorSpace(
  const RCP<const VectorSpaceBase<double> > &parentSpace,
  const int dim
  );


RCP<VectorBase<double> >
create_Vector(
  const RCP<Epetra_Vector> &epetra_v,
  const RCP<const VectorSpaceBase<double> > &space = Teuchos::null
  );


RCP<const VectorBase<double> >
create_Vector(
  const RCP<const Epetra_Vector> &epetra_v,
  const RCP<const VectorSpaceBase<double> > &space = Teuchos::null
  );


RCP<MultiVectorBase<double> >
create_MultiVector(
  const RCP<Epetra_MultiVector> &epetra_mv,
  const RCP<const VectorSpaceBase<double> > &range = Teuchos::null,
  const RCP<const VectorSpaceBase<double> > &domain = Teuchos::null
  );


RCP<const MultiVectorBase<double> >
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
  );


RCP<const Epetra_Comm>
get_Epetra_Comm(const Teuchos::Comm<Ordinal>& comm);


RCP<const Epetra_Map>
get_Epetra_Map(const VectorSpaceBase<double>& vs, const RCP<const Epetra_Comm>& comm);

// Almost like the above one, but working on an RCP vs as input, we can check for the
// presence of RCP<const Epetra_Map> in the RCP extra data, to save us time.
RCP<const Epetra_Map>
get_Epetra_Map(const RCP<const VectorSpaceBase<double>>& vs,
               const RCP<const Epetra_Comm>& comm = Teuchos::null);

RCP<Epetra_Vector>
get_Epetra_Vector(
  const Epetra_Map &map,
  const RCP<VectorBase<double> > &v
  );

// Same as above, except allows to not pass the map (in case the RCP of v
// already has an attached RCP<Epetra_Vector>)
RCP<Epetra_Vector>
get_Epetra_Vector(
  const RCP<VectorBase<double> > &v,
  const RCP<const Epetra_Map>& map = Teuchos::null
  );


RCP<const Epetra_Vector>
get_Epetra_Vector(
  const Epetra_Map &map,
  const RCP<const VectorBase<double> > &v
  );

// Same as above, except allows to not pass the map (in case the RCP of v
// already has an attached RCP<const Epetra_Vector>)
RCP<const Epetra_Vector>
get_Epetra_Vector(
  const RCP<const VectorBase<double> > &v,
  const RCP<const Epetra_Map>& map = Teuchos::null
  );

RCP<Epetra_MultiVector>
get_Epetra_MultiVector(
  const Epetra_Map &map,
  const RCP<MultiVectorBase<double> > &mv
  );

// Same as above, except allows to not pass the map (in case the RCP of v
// already has an attached RCP<Epetra_MultiVector>)
RCP<Epetra_MultiVector>
get_Epetra_MultiVector(
  const RCP<MultiVectorBase<double> > &mv,
  const RCP<const Epetra_Map>& map = Teuchos::null
  );


RCP<const Epetra_MultiVector>
get_Epetra_MultiVector(
  const Epetra_Map &map, 
  const RCP<const MultiVectorBase<double> > &mv
  );

// Same as above, except allows to not pass the map (in case the RCP of v
// already has an attached RCP<const Epetra_MultiVector>)
RCP<const Epetra_MultiVector>
get_Epetra_MultiVector(
  const RCP<const MultiVectorBase<double> > &mv,
  const RCP<const Epetra_Map>& map = Teuchos::null
  );


Teuchos::RCP<Epetra_MultiVector>
get_Epetra_MultiVector(
  const Epetra_Map &map,
  MultiVectorBase<double> &mv
  );


Teuchos::RCP<const Epetra_MultiVector>
get_Epetra_MultiVector(
  const Epetra_Map &map,
  const MultiVectorBase<double> &mv
  );


} // namespace Thyra


#endif // THYRA_EPETRA_THYRA_WRAPPERS_HPP