AMP::LinearAlgebra::VS_ByVariableName Class Reference

Select a subvector based on the name of the variable. More...

#include <VectorSelector.h>

Inheritance diagram for AMP::LinearAlgebra::VS_ByVariableName:

Public Member Functions
virtual AMP_MPI	communicator (const Vector &vec) const
	Returns the communicator for the subset.
const std::string &	getName () const
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_ByVariableName (std::string name)
	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::string	d_VecName

Detailed Description

Select a subvector based on the name of the variable.

This can be used in the Vector::select or Vector::selectInto interface:

// Create a vector of all data in the simulation
auto data = meshManager->createVector( complexVariable );
 
// Extract all data called "Temperature"
auto temperature = data->select ( VS_ByVariableName( "Temperature" ), "Temperature" );
 
// Add displacement data to a vector results
data->select ( VS_ByBariableName( "Displacement" ), results );

Definition at line 77 of file VectorSelector.h.

Constructor & Destructor Documentation

VS_ByVariableName()

AMP::LinearAlgebra::VS_ByVariableName::VS_ByVariableName

(

std::string

name

)

Constructor.

Parameters

[in]

name

The name of the variable to subset on

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

getName()

const std::string & AMP::LinearAlgebra::VS_ByVariableName::getName ( ) const

inline

Definition at line 88 of file VectorSelector.h.

References d_VecName.

isSelected()

virtual bool AMP::LinearAlgebra::VS_ByVariableName::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_ByVariableName::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_VecName

std::string AMP::LinearAlgebra::VS_ByVariableName::d_VecName

protected

Definition at line 80 of file VectorSelector.h.

Referenced by getName().

---

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

• src/vectors/VectorSelector.h