Xpetra Version of the Day
Loading...
Searching...
No Matches
Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > Class Template Reference

#include <Xpetra_BlockedMultiVector_decl.hpp>

Inheritance diagram for Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >:
Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > Xpetra::DistObject< Packet, LocalOrdinal, GlobalOrdinal, Node > Teuchos::Describable Teuchos::LabeledObject Xpetra::BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > Xpetra::ReorderedBlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Public Types

typedef Scalar scalar_type
 
typedef LocalOrdinal local_ordinal_type
 
typedef GlobalOrdinal global_ordinal_type
 
typedef Node node_type
 
- Public Types inherited from Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >
typedef Scalar scalar_type
 
typedef LocalOrdinal local_ordinal_type
 
typedef GlobalOrdinal global_ordinal_type
 
typedef Node node_type
 
using impl_scalar_type = typename Kokkos::Details::ArithTraits<Scalar>::val_type
 
using dual_view_type = Kokkos::DualView<impl_scalar_type**, Kokkos::LayoutStride, typename node_type::device_type, Kokkos::MemoryUnmanaged>
 
using dual_view_type_const = Kokkos::DualView<const impl_scalar_type**, Kokkos::LayoutStride, typename node_type::device_type, Kokkos::MemoryUnmanaged>
 
using host_execution_space = typename dual_view_type::host_mirror_space
 
using dev_execution_space = typename dual_view_type::t_dev::execution_space
 

Xpetra specific

Teuchos::RCP< const BlockedMapmap_
 blocked map containing the sub block maps (either thyra or xpetra mode)
 
std::vector< Teuchos::RCP< MultiVector > > vv_
 array containing RCPs of the partial vectors
 
size_t numVectors_
 number of vectors (columns in multi vector)
 
virtual void setSeed (unsigned int seed)
 Set seed for Random function.
 
virtual void randomize (bool bUseXpetraImplementation=false)
 Set multi-vector values to random numbers.
 
virtual void randomize (const Scalar &minVal, const Scalar &maxVal, bool bUseXpetraImplementation=false)
 Set multi-vector values to random numbers.
 
virtual void Xpetra_randomize ()
 Set multi-vector values to random numbers. XPetra implementation.
 
virtual void Xpetra_randomize (const Scalar &minVal, const Scalar &maxVal)
 Set multi-vector values to random numbers. XPetra implementation.
 
Teuchos::RCP< const MapgetMap () const
 Access function for the underlying Map this DistObject was constructed with.
 
Teuchos::RCP< const Xpetra::BlockedMap< LocalOrdinal, GlobalOrdinal, Node > > getBlockedMap () const
 Access function for the underlying Map this DistObject was constructed with.
 
Teuchos::RCP< MultiVectorgetMultiVector (size_t r) const
 return partial multivector associated with block row r
 
Teuchos::RCP< MultiVectorgetMultiVector (size_t r, bool bThyraMode) const
 return partial multivector associated with block row r
 
void setMultiVector (size_t r, Teuchos::RCP< const MultiVector > v, bool bThyraMode)
 set partial multivector associated with block row r
 
Teuchos::RCP< MultiVectorMerge () const
 merge BlockedMultiVector blocks to a single MultiVector
 
virtual void assign (const MultiVector &rhs)
 Implementation of the assignment operator (operator=); does a deep copy.
 
void ExtractVector (RCP< const MultiVector > &full, size_t block, RCP< MultiVector > &partial) const
 
void ExtractVector (RCP< MultiVector > &full, size_t block, RCP< MultiVector > &partial) const
 
RCP< MultiVectorExtractVector (RCP< const MultiVector > &full, size_t block, bool bThyraMode=false) const
 
RCP< MultiVectorExtractVector (RCP< MultiVector > &full, size_t block, bool bThyraMode=false) const
 
void ExtractVector (const MultiVector &full, size_t block, MultiVector &partial) const
 
void InsertVector (const MultiVector &partial, size_t block, MultiVector &full, bool bThyraMode=false) const
 
void InsertVector (RCP< const MultiVector > partial, size_t block, RCP< MultiVector > full, bool bThyraMode=false) const
 
void InsertVector (RCP< MultiVector > partial, size_t block, RCP< MultiVector > full, bool bThyraMode=false) const
 

Constructor/Destructor Methods

 BlockedMultiVector (const Teuchos::RCP< const BlockedMap > &map, size_t NumVectors, bool zeroOut=true)
 Constructor.
 
 BlockedMultiVector (Teuchos::RCP< const Xpetra::BlockedMap< LocalOrdinal, GlobalOrdinal, Node > > bmap, Teuchos::RCP< const MultiVector > v)
 
 BlockedMultiVector (Teuchos::RCP< const Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node > > mapExtractor, Teuchos::RCP< const MultiVector > v)
 
 BlockedMultiVector (const Teuchos::RCP< const BlockedMap > &map, std::vector< Teuchos::RCP< MultiVector > > &vin)
 
virtual ~BlockedMultiVector ()
 Destructor.
 
BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > & operator= (const MultiVector &rhs)
 Assignment operator: Does a deep copy.
 

Post-construction modification routines

virtual void replaceGlobalValue (GlobalOrdinal, size_t, const Scalar &)
 Replace value, using global (row) index.
 
virtual void sumIntoGlobalValue (GlobalOrdinal, size_t, const Scalar &)
 Add value to existing value, using global (row) index.
 
virtual void replaceLocalValue (LocalOrdinal, size_t, const Scalar &)
 Replace value, using local (row) index.
 
virtual void sumIntoLocalValue (LocalOrdinal, size_t, const Scalar &)
 Add value to existing value, using local (row) index.
 
virtual void putScalar (const Scalar &value)
 Set all values in the multivector with the given value.
 

Data Copy and View get methods

virtual Teuchos::RCP< const Xpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > getVector (size_t j) const
 Return a Vector which is a const view of column j.
 
virtual Teuchos::RCP< Xpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > getVectorNonConst (size_t j)
 Return a Vector which is a nonconst view of column j.
 
virtual Teuchos::ArrayRCP< const Scalar > getData (size_t j) const
 Const view of the local values in a particular vector of this multivector.
 
virtual Teuchos::ArrayRCP< Scalar > getDataNonConst (size_t j)
 View of the local values in a particular vector of this multivector.
 

Mathematical methods

virtual void dot (const MultiVector &, const Teuchos::ArrayView< Scalar > &) const
 Compute dot product of each corresponding pair of vectors, dots[i] = this[i].dot(A[i]).
 
virtual void abs (const MultiVector &)
 Put element-wise absolute values of input Multi-vector in target: A = abs(this).
 
virtual void reciprocal (const MultiVector &)
 Put element-wise reciprocal values of input Multi-vector in target, this(i,j) = 1/A(i,j).
 
virtual void scale (const Scalar &alpha)
 Scale the current values of a multi-vector, this = alpha*this.
 
virtual void scale (Teuchos::ArrayView< const Scalar > alpha)
 Scale the current values of a multi-vector, this[j] = alpha[j]*this[j].
 
virtual void update (const Scalar &alpha, const MultiVector &A, const Scalar &beta)
 Update multi-vector values with scaled values of A, this = beta*this + alpha*A.
 
virtual void update (const Scalar &alpha, const MultiVector &A, const Scalar &beta, const MultiVector &B, const Scalar &gamma)
 Update multi-vector with scaled values of A and B, this = gamma*this + alpha*A + beta*B.
 
virtual void norm1 (const Teuchos::ArrayView< typename Teuchos::ScalarTraits< Scalar >::magnitudeType > &norms) const
 Compute 1-norm of each vector in multi-vector.
 
virtual void norm2 (const Teuchos::ArrayView< typename Teuchos::ScalarTraits< Scalar >::magnitudeType > &norms) const
 
virtual void normInf (const Teuchos::ArrayView< typename Teuchos::ScalarTraits< Scalar >::magnitudeType > &norms) const
 Compute Inf-norm of each vector in multi-vector.
 
virtual void meanValue (const Teuchos::ArrayView< Scalar > &) const
 Compute mean (average) value of each vector in multi-vector. The outcome of this routine is undefined for non-floating point scalar types (e.g., int).
 
virtual void multiply (Teuchos::ETransp, Teuchos::ETransp, const Scalar &, const MultiVector &, const MultiVector &, const Scalar &)
 Matrix-matrix multiplication: this = beta*this + alpha*op(A)*op(B).
 
virtual void elementWiseMultiply (Scalar scalarAB, const Xpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A, const MultiVector &B, Scalar scalarThis)
 Element-wise multiply of a Vector A with a MultiVector B.
 

Attribute access functions

virtual size_t getNumVectors () const
 Number of columns in the multivector.
 
virtual size_t getLocalLength () const
 Local number of rows on the calling process.
 
virtual global_size_t getGlobalLength () const
 Global number of rows in the multivector.
 
virtual bool isSameSize (const Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &vec) const
 Local number of rows on the calling process.
 

Overridden from Teuchos::Describable

virtual std::string description () const
 A simple one-line description of this object.
 
virtual void describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default) const
 Print the object with the given verbosity level to a FancyOStream.
 
virtual void replaceMap (const RCP< const Map > &map)
 
virtual void doImport (const DistObject< Scalar, LocalOrdinal, GlobalOrdinal, Node > &, const Import &, CombineMode)
 Import.
 
virtual void doExport (const DistObject< Scalar, LocalOrdinal, GlobalOrdinal, Node > &, const Import &, CombineMode)
 Export.
 
virtual void doImport (const DistObject< Scalar, LocalOrdinal, GlobalOrdinal, Node > &, const Export &, CombineMode)
 Import (using an Exporter).
 
virtual void doExport (const DistObject< Scalar, LocalOrdinal, GlobalOrdinal, Node > &, const Export &, CombineMode)
 Export (using an Importer).
 

Additional Inherited Members

- Public Member Functions inherited from Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >
virtual dual_view_type::t_host_const_um getHostLocalView (Access::ReadOnlyStruct) const
 
virtual dual_view_type::t_dev_const_um getDeviceLocalView (Access::ReadOnlyStruct) const
 
virtual dual_view_type::t_host_um getHostLocalView (Access::OverwriteAllStruct) const
 
virtual dual_view_type::t_dev_um getDeviceLocalView (Access::OverwriteAllStruct) const
 
virtual dual_view_type::t_host_um getHostLocalView (Access::ReadWriteStruct) const
 
virtual dual_view_type::t_dev_um getDeviceLocalView (Access::ReadWriteStruct) const
 
virtual ~MultiVector ()
 Destructor.
 
MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > & operator= (const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &rhs)
 Assignment operator: Does a deep copy.
 
- Public Member Functions inherited from Xpetra::DistObject< Packet, LocalOrdinal, GlobalOrdinal, Node >
virtual ~DistObject ()
 Destructor.
 
virtual void doImport (const DistObject< Packet, LocalOrdinal, GlobalOrdinal, Node > &source, const Import< LocalOrdinal, GlobalOrdinal, Node > &importer, CombineMode CM)=0
 Import data into this object using an Import object ("forward mode").
 
virtual void beginImport (const DistObject< Packet, LocalOrdinal, GlobalOrdinal, Node > &source, const Import< LocalOrdinal, GlobalOrdinal, Node > &importer, CombineMode CM)
 Import data into this object using an Import object ("forward mode").
 
virtual void endImport (const DistObject< Packet, LocalOrdinal, GlobalOrdinal, Node > &source, const Import< LocalOrdinal, GlobalOrdinal, Node > &importer, CombineMode CM)
 Import data into this object using an Import object ("forward mode").
 
virtual void doExport (const DistObject< Packet, LocalOrdinal, GlobalOrdinal, Node > &source, const Export< LocalOrdinal, GlobalOrdinal, Node > &exporter, CombineMode CM)=0
 Export data into this object using an Export object ("forward mode").
 
virtual void beginExport (const DistObject< Packet, LocalOrdinal, GlobalOrdinal, Node > &source, const Export< LocalOrdinal, GlobalOrdinal, Node > &exporter, CombineMode CM)
 Export data into this object using an Export object ("forward mode").
 
virtual void endExport (const DistObject< Packet, LocalOrdinal, GlobalOrdinal, Node > &source, const Export< LocalOrdinal, GlobalOrdinal, Node > &exporter, CombineMode CM)
 Export data into this object using an Export object ("forward mode").
 
virtual void doImport (const DistObject< Packet, LocalOrdinal, GlobalOrdinal, Node > &source, const Export< LocalOrdinal, GlobalOrdinal, Node > &exporter, CombineMode CM)=0
 Import data into this object using an Export object ("reverse mode").
 
virtual void beginImport (const DistObject< Packet, LocalOrdinal, GlobalOrdinal, Node > &source, const Export< LocalOrdinal, GlobalOrdinal, Node > &exporter, CombineMode CM)
 Import data into this object using an Export object ("reverse mode").
 
virtual void endImport (const DistObject< Packet, LocalOrdinal, GlobalOrdinal, Node > &source, const Export< LocalOrdinal, GlobalOrdinal, Node > &exporter, CombineMode CM)
 Import data into this object using an Export object ("reverse mode").
 
virtual void doExport (const DistObject< Packet, LocalOrdinal, GlobalOrdinal, Node > &source, const Import< LocalOrdinal, GlobalOrdinal, Node > &importer, CombineMode CM)=0
 Export data into this object using an Import object ("reverse mode").
 
virtual void beginExport (const DistObject< Packet, LocalOrdinal, GlobalOrdinal, Node > &source, const Import< LocalOrdinal, GlobalOrdinal, Node > &importer, CombineMode CM)
 Export data into this object using an Import object ("reverse mode").
 
virtual void endExport (const DistObject< Packet, LocalOrdinal, GlobalOrdinal, Node > &source, const Import< LocalOrdinal, GlobalOrdinal, Node > &importer, CombineMode CM)
 Export data into this object using an Import object ("reverse mode").
 
- Public Member Functions inherited from Teuchos::Describable
void describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
 
virtual ~Describable ()
 
DescribableStreamManipulatorState describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default)
 
std::ostream & operator<< (std::ostream &os, const DescribableStreamManipulatorState &d)
 
void describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
 
virtual ~Describable ()
 
- Public Member Functions inherited from Teuchos::LabeledObject
 LabeledObject ()
 
virtual ~LabeledObject ()
 
virtual void setObjectLabel (const std::string &objectLabel)
 
virtual std::string getObjectLabel () const
 
- Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel verbLevel_default
 
- Protected Member Functions inherited from Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Detailed Description

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
class Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Definition at line 75 of file Xpetra_BlockedMultiVector_decl.hpp.

Member Typedef Documentation

◆ scalar_type

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node = KokkosClassic::DefaultNode::DefaultNodeType>
typedef Scalar Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::scalar_type

Definition at line 79 of file Xpetra_BlockedMultiVector_decl.hpp.

◆ local_ordinal_type

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node = KokkosClassic::DefaultNode::DefaultNodeType>
typedef LocalOrdinal Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::local_ordinal_type

Definition at line 80 of file Xpetra_BlockedMultiVector_decl.hpp.

◆ global_ordinal_type

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node = KokkosClassic::DefaultNode::DefaultNodeType>
typedef GlobalOrdinal Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::global_ordinal_type

Definition at line 81 of file Xpetra_BlockedMultiVector_decl.hpp.

◆ node_type

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node = KokkosClassic::DefaultNode::DefaultNodeType>
typedef Node Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::node_type

Definition at line 82 of file Xpetra_BlockedMultiVector_decl.hpp.

Constructor & Destructor Documentation

◆ BlockedMultiVector() [1/4]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::BlockedMultiVector ( const Teuchos::RCP< const BlockedMap > & map,
size_t NumVectors,
bool zeroOut = true )

Constructor.

Const version of constructor which accepts a const version of a blocked map

Parameters
mapBlockedMap defining the block structure of the multi vector
NumVectorsNumber of vector columns in multi vector
zeroOutIf true initialize multivector with zeros

Definition at line 61 of file Xpetra_BlockedMultiVector_def.hpp.

◆ BlockedMultiVector() [2/4]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::BlockedMultiVector ( Teuchos::RCP< const Xpetra::BlockedMap< LocalOrdinal, GlobalOrdinal, Node > > bmap,
Teuchos::RCP< const MultiVector > v )

Const version of constructor which accepts a const version of the multi-vector

Note
If you change the information in input vector v the data in the blocked multi-vector are not affected (and vice versa). Consider the blocked multivector to be a copy of the input multivector (not a view)
Parameters
bmapBlockedMap object containing information about the block splitting
vMultiVector that is to be splitted into a blocked multi vector

Definition at line 90 of file Xpetra_BlockedMultiVector_def.hpp.

◆ BlockedMultiVector() [3/4]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::BlockedMultiVector ( Teuchos::RCP< const Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node > > mapExtractor,
Teuchos::RCP< const MultiVector > v )

Const version of constructor which accepts a const version of the multi-vector

Note
If you change the information in input vector v the data in the blocked multi-vector are not affected (and vice versa). Consider the blocked multivector to be a copy of the input multivector (not a view)
Parameters
mapExtractorMapExtractor object containing information about the block splitting
vMultiVector that is to be splitted into a blocked multi vector

Definition at line 136 of file Xpetra_BlockedMultiVector_def.hpp.

◆ BlockedMultiVector() [4/4]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::BlockedMultiVector ( const Teuchos::RCP< const BlockedMap > & map,
std::vector< Teuchos::RCP< MultiVector > > & vin )

Constructor to build a blocked multivector from a blocked map and component vectors

Note
We do NOT check map compatibility between the BlockedMap and the array of multivectors
Parameters
mapBlockedMap object containing information about the block splitting
vinA std::vector of RCPs to component vectors

Definition at line 159 of file Xpetra_BlockedMultiVector_def.hpp.

◆ ~BlockedMultiVector()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::~BlockedMultiVector ( )
virtual

Destructor.

Definition at line 172 of file Xpetra_BlockedMultiVector_def.hpp.

Member Function Documentation

◆ operator=()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > & Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::operator= ( const MultiVector & rhs)

Assignment operator: Does a deep copy.

The assignment operator does a deep copy, just like subclasses' copy constructors.

Note
This currently only works if both *this and the input argument are instances of the same subclass.

Definition at line 187 of file Xpetra_BlockedMultiVector_def.hpp.

◆ replaceGlobalValue()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::replaceGlobalValue ( GlobalOrdinal ,
size_t ,
const Scalar &  )
virtual

◆ sumIntoGlobalValue()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::sumIntoGlobalValue ( GlobalOrdinal ,
size_t ,
const Scalar &  )
virtual

Add value to existing value, using global (row) index.

Implements Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Reimplemented in Xpetra::BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 206 of file Xpetra_BlockedMultiVector_def.hpp.

◆ replaceLocalValue()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::replaceLocalValue ( LocalOrdinal ,
size_t ,
const Scalar &  )
virtual

◆ sumIntoLocalValue()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::sumIntoLocalValue ( LocalOrdinal ,
size_t ,
const Scalar &  )
virtual

Add value to existing value, using local (row) index.

Implements Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Reimplemented in Xpetra::BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 223 of file Xpetra_BlockedMultiVector_def.hpp.

◆ putScalar()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::putScalar ( const Scalar & value)
virtual

Set all values in the multivector with the given value.

Implements Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Reimplemented in Xpetra::BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 233 of file Xpetra_BlockedMultiVector_def.hpp.

◆ getVector()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
Teuchos::RCP< const Xpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getVector ( size_t j) const
virtual

◆ getVectorNonConst()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
Teuchos::RCP< Xpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getVectorNonConst ( size_t j)
virtual

◆ getData()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
Teuchos::ArrayRCP< const Scalar > Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getData ( size_t j) const
virtual

Const view of the local values in a particular vector of this multivector.

Implements Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Reimplemented in Xpetra::BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 275 of file Xpetra_BlockedMultiVector_def.hpp.

◆ getDataNonConst()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
Teuchos::ArrayRCP< Scalar > Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getDataNonConst ( size_t j)
virtual

View of the local values in a particular vector of this multivector.

Implements Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Reimplemented in Xpetra::BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 289 of file Xpetra_BlockedMultiVector_def.hpp.

◆ dot()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::dot ( const MultiVector & ,
const Teuchos::ArrayView< Scalar > &  ) const
virtual

Compute dot product of each corresponding pair of vectors, dots[i] = this[i].dot(A[i]).

Implements Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Reimplemented in Xpetra::BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 303 of file Xpetra_BlockedMultiVector_def.hpp.

◆ abs()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::abs ( const MultiVector & )
virtual

Put element-wise absolute values of input Multi-vector in target: A = abs(this).

Implements Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Reimplemented in Xpetra::BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 312 of file Xpetra_BlockedMultiVector_def.hpp.

◆ reciprocal()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::reciprocal ( const MultiVector & )
virtual

Put element-wise reciprocal values of input Multi-vector in target, this(i,j) = 1/A(i,j).

Implements Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Reimplemented in Xpetra::BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 321 of file Xpetra_BlockedMultiVector_def.hpp.

◆ scale() [1/2]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::scale ( const Scalar & alpha)
virtual

Scale the current values of a multi-vector, this = alpha*this.

Implements Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Reimplemented in Xpetra::BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 330 of file Xpetra_BlockedMultiVector_def.hpp.

◆ scale() [2/2]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::scale ( Teuchos::ArrayView< const Scalar > alpha)
virtual

Scale the current values of a multi-vector, this[j] = alpha[j]*this[j].

Implements Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Reimplemented in Xpetra::BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 346 of file Xpetra_BlockedMultiVector_def.hpp.

◆ update() [1/2]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::update ( const Scalar & alpha,
const MultiVector & A,
const Scalar & beta )
virtual

Update multi-vector values with scaled values of A, this = beta*this + alpha*A.

Implements Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Reimplemented in Xpetra::BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 362 of file Xpetra_BlockedMultiVector_def.hpp.

◆ update() [2/2]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::update ( const Scalar & alpha,
const MultiVector & A,
const Scalar & beta,
const MultiVector & B,
const Scalar & gamma )
virtual

Update multi-vector with scaled values of A and B, this = gamma*this + alpha*A + beta*B.

Implements Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Reimplemented in Xpetra::BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 467 of file Xpetra_BlockedMultiVector_def.hpp.

◆ norm1()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::norm1 ( const Teuchos::ArrayView< typename Teuchos::ScalarTraits< Scalar >::magnitudeType > & norms) const
virtual

◆ norm2()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::norm2 ( const Teuchos::ArrayView< typename Teuchos::ScalarTraits< Scalar >::magnitudeType > & norms) const
virtual

◆ normInf()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::normInf ( const Teuchos::ArrayView< typename Teuchos::ScalarTraits< Scalar >::magnitudeType > & norms) const
virtual

Compute Inf-norm of each vector in multi-vector.

Implements Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Reimplemented in Xpetra::BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 562 of file Xpetra_BlockedMultiVector_def.hpp.

◆ meanValue()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::meanValue ( const Teuchos::ArrayView< Scalar > & ) const
virtual

Compute mean (average) value of each vector in multi-vector. The outcome of this routine is undefined for non-floating point scalar types (e.g., int).

Implements Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Reimplemented in Xpetra::BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 584 of file Xpetra_BlockedMultiVector_def.hpp.

◆ multiply()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::multiply ( Teuchos::ETransp ,
Teuchos::ETransp ,
const Scalar & ,
const MultiVector & ,
const MultiVector & ,
const Scalar &  )
virtual

Matrix-matrix multiplication: this = beta*this + alpha*op(A)*op(B).

Implements Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Reimplemented in Xpetra::BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 593 of file Xpetra_BlockedMultiVector_def.hpp.

◆ elementWiseMultiply()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::elementWiseMultiply ( Scalar scalarAB,
const Xpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > & A,
const MultiVector & B,
Scalar scalarThis )
virtual

◆ getNumVectors()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
size_t Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getNumVectors ( ) const
virtual

◆ getLocalLength()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
size_t Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getLocalLength ( ) const
virtual

◆ getGlobalLength()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
global_size_t Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getGlobalLength ( ) const
virtual

◆ isSameSize()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
bool Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::isSameSize ( const Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > & vec) const
virtual

◆ description()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
std::string Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::description ( ) const
virtual

◆ describe()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::describe ( Teuchos::FancyOStream & out,
const Teuchos::EVerbosityLevel verbLevel = Teuchos::Describable::verbLevel_default ) const
virtual

◆ replaceMap()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::replaceMap ( const RCP< const Map > & map)
virtual

◆ doImport() [1/2]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::doImport ( const DistObject< Scalar, LocalOrdinal, GlobalOrdinal, Node > & ,
const Import & ,
CombineMode  )
virtual

◆ doExport() [1/2]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::doExport ( const DistObject< Scalar, LocalOrdinal, GlobalOrdinal, Node > & ,
const Import & ,
CombineMode  )
virtual

◆ doImport() [2/2]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::doImport ( const DistObject< Scalar, LocalOrdinal, GlobalOrdinal, Node > & ,
const Export & ,
CombineMode  )
virtual

Import (using an Exporter).

Reimplemented in Xpetra::BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 780 of file Xpetra_BlockedMultiVector_def.hpp.

◆ doExport() [2/2]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::doExport ( const DistObject< Scalar, LocalOrdinal, GlobalOrdinal, Node > & ,
const Export & ,
CombineMode  )
virtual

Export (using an Importer).

Reimplemented in Xpetra::BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 791 of file Xpetra_BlockedMultiVector_def.hpp.

◆ setSeed()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::setSeed ( unsigned int seed)
virtual

◆ randomize() [1/2]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::randomize ( bool bUseXpetraImplementation = false)
virtual

◆ randomize() [2/2]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::randomize ( const Scalar & minVal,
const Scalar & maxVal,
bool bUseXpetraImplementation = false )
virtual

◆ Xpetra_randomize() [1/2]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Xpetra_randomize ( )
virtual

Set multi-vector values to random numbers. XPetra implementation.

Reimplemented from Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Reimplemented in Xpetra::BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 838 of file Xpetra_BlockedMultiVector_def.hpp.

◆ Xpetra_randomize() [2/2]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Xpetra_randomize ( const Scalar & minVal,
const Scalar & maxVal )
virtual

Set multi-vector values to random numbers. XPetra implementation.

Reimplemented from Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Reimplemented in Xpetra::BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 847 of file Xpetra_BlockedMultiVector_def.hpp.

◆ getMap()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
Teuchos::RCP< const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getMap ( ) const
virtual

◆ getBlockedMap()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
Teuchos::RCP< const Xpetra::BlockedMap< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getBlockedMap ( ) const

Access function for the underlying Map this DistObject was constructed with.

Definition at line 866 of file Xpetra_BlockedMultiVector_def.hpp.

◆ getMultiVector() [1/2]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
Teuchos::RCP< Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getMultiVector ( size_t r) const

return partial multivector associated with block row r

Definition at line 876 of file Xpetra_BlockedMultiVector_def.hpp.

◆ getMultiVector() [2/2]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
Teuchos::RCP< Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getMultiVector ( size_t r,
bool bThyraMode ) const

return partial multivector associated with block row r

Definition at line 890 of file Xpetra_BlockedMultiVector_def.hpp.

◆ setMultiVector()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::setMultiVector ( size_t r,
Teuchos::RCP< const MultiVector > v,
bool bThyraMode )

set partial multivector associated with block row r

Definition at line 907 of file Xpetra_BlockedMultiVector_def.hpp.

◆ Merge()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
Teuchos::RCP< Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Merge ( ) const

merge BlockedMultiVector blocks to a single MultiVector

Definition at line 935 of file Xpetra_BlockedMultiVector_def.hpp.

◆ assign()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::assign ( const MultiVector & rhs)
protectedvirtual

Implementation of the assignment operator (operator=); does a deep copy.

Each subclass must implement this. This includes Xpetra::EpetraMultiVector and Xpetra::TpetraMultiVector as well as Xpetra::BockedMultiVector

Implements Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Reimplemented in Xpetra::BlockedVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 965 of file Xpetra_BlockedMultiVector_def.hpp.

◆ ExtractVector() [1/5]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::ExtractVector ( RCP< const MultiVector > & full,
size_t block,
RCP< MultiVector > & partial ) const
private

Definition at line 1029 of file Xpetra_BlockedMultiVector_def.hpp.

◆ ExtractVector() [2/5]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::ExtractVector ( RCP< MultiVector > & full,
size_t block,
RCP< MultiVector > & partial ) const
private

Definition at line 1040 of file Xpetra_BlockedMultiVector_def.hpp.

◆ ExtractVector() [3/5]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
RCP< Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::ExtractVector ( RCP< const MultiVector > & full,
size_t block,
bool bThyraMode = false ) const
private

Definition at line 1051 of file Xpetra_BlockedMultiVector_def.hpp.

◆ ExtractVector() [4/5]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
RCP< Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::ExtractVector ( RCP< MultiVector > & full,
size_t block,
bool bThyraMode = false ) const
private

Definition at line 1102 of file Xpetra_BlockedMultiVector_def.hpp.

◆ ExtractVector() [5/5]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::ExtractVector ( const MultiVector & full,
size_t block,
MultiVector & partial ) const
private

Definition at line 1152 of file Xpetra_BlockedMultiVector_def.hpp.

◆ InsertVector() [1/3]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::InsertVector ( const MultiVector & partial,
size_t block,
MultiVector & full,
bool bThyraMode = false ) const
private

Definition at line 1168 of file Xpetra_BlockedMultiVector_def.hpp.

◆ InsertVector() [2/3]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::InsertVector ( RCP< const MultiVector > partial,
size_t block,
RCP< MultiVector > full,
bool bThyraMode = false ) const
private

Definition at line 1229 of file Xpetra_BlockedMultiVector_def.hpp.

◆ InsertVector() [3/3]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node = KokkosClassic::DefaultNode::DefaultNodeType>
void Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::InsertVector ( RCP< MultiVector > partial,
size_t block,
RCP< MultiVector > full,
bool bThyraMode = false ) const
private

Member Data Documentation

◆ map_

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node = KokkosClassic::DefaultNode::DefaultNodeType>
Teuchos::RCP<const BlockedMap> Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::map_
private

blocked map containing the sub block maps (either thyra or xpetra mode)

Definition at line 395 of file Xpetra_BlockedMultiVector_decl.hpp.

◆ vv_

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node = KokkosClassic::DefaultNode::DefaultNodeType>
std::vector<Teuchos::RCP<MultiVector> > Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::vv_
private

array containing RCPs of the partial vectors

Definition at line 396 of file Xpetra_BlockedMultiVector_decl.hpp.

◆ numVectors_

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node = KokkosClassic::DefaultNode::DefaultNodeType>
size_t Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::numVectors_
private

number of vectors (columns in multi vector)

Definition at line 397 of file Xpetra_BlockedMultiVector_decl.hpp.


The documentation for this class was generated from the following files: