AMP::LinearAlgebra::VS_Components Class Reference

Create a subset based on the components of a vector. More...

#include <VectorSelector.h>

Inheritance diagram for AMP::LinearAlgebra::VS_Components:

Public Member Functions
virtual AMP_MPI	communicator (const Vector &vec) const
	Returns the communicator for the subset.
const auto &	getIndices () const
	Get the indices.
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_Components (size_t index)
	Constructor.
	VS_Components (std::vector< size_t > index)
	Constructor.

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

Protected Attributes
std::vector< size_t >	d_index

Detailed Description

Create a subset based on the components of a vector.

This will select the given components of a vector

Definition at line 123 of file VectorSelector.h.

Constructor & Destructor Documentation

VS_Components() [1/2]

AMP::LinearAlgebra::VS_Components::VS_Components

(

size_t

index

)

Constructor.

Parameters

[in]

index

The component index to subset

VS_Components() [2/2]

AMP::LinearAlgebra::VS_Components::VS_Components ( std::vector< size_t >  index )

explicit

Constructor.

Parameters

[in]

index

The component indices to subset

Member Function Documentation

communicator()

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

virtualinherited

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 in AMP::LinearAlgebra::VS_Comm, and AMP::LinearAlgebra::VS_Mesh.

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

getIndices()

const auto & AMP::LinearAlgebra::VS_Components::getIndices ( ) const

inline

Get the indices.

Definition at line 137 of file VectorSelector.h.

References d_index.

isSelected()

virtual bool AMP::LinearAlgebra::VS_Components::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_Components::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_index

std::vector<size_t> AMP::LinearAlgebra::VS_Components::d_index

protected

Definition at line 145 of file VectorSelector.h.

Referenced by getIndices().

---

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

• src/vectors/VectorSelector.h