AMP::LinearAlgebra::VS_Comm Class Reference

Create a subset based on a AMP_MPI comm. More...

#include <VectorSelector.h>

Inheritance diagram for AMP::LinearAlgebra::VS_Comm:

Public Member Functions
virtual AMP_MPI	communicator (const Vector &vec) const override
	Returns the communicator for the subset.
virtual bool	isSelected (const Vector &v) const override
	Returns true if Vector grossly matches a selection condition.
std::shared_ptr< const Vector >	subset (std::shared_ptr< const Vector > vec) const
	Subset the given vector.
virtual std::shared_ptr< Vector >	subset (std::shared_ptr< Vector > vec) const override
	Subset the given vector.
virtual std::shared_ptr< Vector >	subset (std::shared_ptr< Vector > vec) const=0
	Subset the given vector.
	VS_Comm (const AMP_MPI &comm)
	Constructor.

Static Public Member Functions
static std::shared_ptr< VectorSelector >	create (const std::vector< std::shared_ptr< VectorSelector > > &selectors)
	Create a VectorSelector.

Protected Attributes
AMP_MPI	d_comm
std::string	d_Name

Detailed Description

Create a subset based on a AMP_MPI comm.

This will pick the part of the vector that lies on the given comm Any parts of the original vector that were on processor that are not in in the new comm will be ignored.

Definition at line 154 of file VectorSelector.h.

Constructor & Destructor Documentation

VS_Comm()

AMP::LinearAlgebra::VS_Comm::VS_Comm ( const AMP_MPI &  comm )

explicit

Constructor.

Parameters

[in]

comm

The new comm to use

Member Function Documentation

communicator()

virtual AMP_MPI AMP::LinearAlgebra::VS_Comm::communicator ( const Vector &  vec ) const

overridevirtual

Returns the communicator for the subset.

Parameters

[in]

vec

The Vector to match

This function will return the proper communicator given the current vector. For most subsetters, this will be the same communicator as the current vector, however some subsetters (MeshSelector) may opperate on a different (smaller) comm.

Reimplemented from AMP::LinearAlgebra::VectorSelector.

create()

static std::shared_ptr< VectorSelector > AMP::LinearAlgebra::VectorSelector::create ( const std::vector< std::shared_ptr< VectorSelector > > &  selectors )

staticinherited

Create a VectorSelector.

Create a VectorSelector that applies a set of selectors which all must be met for the subset operation

Parameters

[in]

selectors

A list of subsequent selectors to apply

isSelected()

virtual bool AMP::LinearAlgebra::VS_Comm::isSelected ( const Vector &  vec ) const

overridevirtual

Returns true if Vector grossly matches a selection condition.

Parameters

[in]

vec

The Vector to match

Base class defaults to accepting all vectors.

Implements AMP::LinearAlgebra::VectorSelector.

subset() [1/3]

std::shared_ptr< const Vector > AMP::LinearAlgebra::VectorSelector::subset ( std::shared_ptr< const Vector >  vec ) const

virtual

Subset the given vector.

Parameters

[in]

vec

The Vector to subset

Base class defaults to returning all data in the vector

Implements AMP::LinearAlgebra::VectorSelector.

subset() [2/3]

virtual std::shared_ptr< Vector > AMP::LinearAlgebra::VS_Comm::subset ( std::shared_ptr< Vector >  vec ) const

overridevirtual

Subset the given vector.

Parameters

[in]

vec

The Vector to subset

Base class defaults to returning all data in the vector

Implements AMP::LinearAlgebra::VectorSelector.

subset() [3/3]

virtual std::shared_ptr< Vector > AMP::LinearAlgebra::VectorSelector::subset ( std::shared_ptr< Vector >  vec ) const

virtual

Subset the given vector.

Parameters

[in]

vec

The Vector to subset

Base class defaults to returning all data in the vector

Implements AMP::LinearAlgebra::VectorSelector.

Member Data Documentation

d_comm

AMP_MPI AMP::LinearAlgebra::VS_Comm::d_comm

protected

Definition at line 170 of file VectorSelector.h.

d_Name

std::string AMP::LinearAlgebra::VS_Comm::d_Name

protected

Definition at line 169 of file VectorSelector.h.

---

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

• src/vectors/VectorSelector.h