A variable used to create a SubsetVector. More...

#include <SubsetVariable.h>

Inheritance diagram for AMP::LinearAlgebra::SubsetVariable:

[legend]

Public Member Functions
std::string	className () const override
	A function that returns the name of a variable.

std::shared_ptr< Variable >	clone () const
	Create a variable of the same type with a new name.

virtual std::shared_ptr< Variable >	clone (const std::string &name) const
	Create a variable of the same type with a new name.

std::shared_ptr< VectorSelector >	createVectorSelector () const override
	Create a VectorSelector.

virtual AMP::AMP_MPI	getComm (const AMP::AMP_MPI &comm) const =0
	Return the comm for the subset.

virtual uint64_t	getID () const
	Get a unique id hash for the vector.

auto &	getName () const
	A function that returns the name of a variable.

virtual std::shared_ptr< AMP::Discretization::DOFManager >	getSubsetDOF (std::shared_ptr< AMP::Discretization::DOFManager > manager) const =0
	Return a DOFManager that describes the subset.

virtual const Units &	getUnits () const
	Get the units of this variable.

bool	operator!= (const Variable &rhs) const
	Inverse of ==.

virtual bool	operator== (const Variable &rhs) const
	Compares two variables for equality.

virtual void	registerChildObjects (AMP::IO::RestartManager *manager) const
	Register any child objects.

virtual void	setUnits (const Units &u)
	Set the units of this variable.

std::shared_ptr< Variable >	shared_from_this ()

std::shared_ptr< const Variable >	shared_from_this () const

	SubsetVariable (const std::string &name)
	Constructor.

	SubsetVariable (int64_t)

virtual Vector::const_shared_ptr	view (Vector::const_shared_ptr) const
	This vector is a subset of an AMP Vector.

virtual Vector::shared_ptr	view (Vector::shared_ptr) const
	This vector is a subset of an AMP Vector.

void	writeRestart (int64_t) const override
	Write restart data to file.

Protected Attributes
AMP::Units	d_Units
	The units this variable is measured in.

std::string	d_VariableName
	A name given to the variable.

std::weak_ptr< Variable >	weak_ptr_

Detailed Description

A variable used to create a SubsetVector.

See also: SubsetVector; VectorIndexer

Definition at line 16 of file SubsetVariable.h.

Constructor & Destructor Documentation

◆ SubsetVariable() [1/2]

AMP::LinearAlgebra::SubsetVariable::SubsetVariable ( const std::string & name )

inlineexplicit

Constructor.

Parameters

[in] name The name of the variable

Definition at line 22 of file SubsetVariable.h.

◆ SubsetVariable() [2/2]

AMP::LinearAlgebra::SubsetVariable::SubsetVariable ( int64_t )

Member Function Documentation

◆ className()

std::string AMP::LinearAlgebra::SubsetVariable::className ( ) const

inlineoverridevirtual

A function that returns the name of a variable.

This gives access to the name

Reimplemented from AMP::LinearAlgebra::Variable.

Definition at line 96 of file SubsetVariable.h.

◆ clone() [1/2]

std::shared_ptr< Variable > AMP::LinearAlgebra::Variable::clone ( ) const

inherited

Create a variable of the same type with a new name.

This function will create a "deep" copy of this variable.

◆ clone() [2/2]

virtual std::shared_ptr< Variable > AMP::LinearAlgebra::Variable::clone ( const std::string & name ) const

virtualinherited

Create a variable of the same type with a new name.

This function will create a "deep" copy of this variable.

Reimplemented in AMP::LinearAlgebra::MultiVariable.

◆ createVectorSelector()

std::shared_ptr< VectorSelector > AMP::LinearAlgebra::SubsetVariable::createVectorSelector ( ) const

overridevirtual

Create a VectorSelector.

This function will create a VectorSelector that is able to subset a vector for the variable. This is used by Vector::subsetVectorForVariable which then calls Vector::selectInto.

Reimplemented from AMP::LinearAlgebra::Variable.

◆ getComm()

virtual AMP::AMP_MPI AMP::LinearAlgebra::SubsetVariable::getComm ( const AMP::AMP_MPI & comm ) const

pure virtual

Return the comm for the subset.

Returns: The comm

Parameters

[in] comm The comm of the original vector / DOFManager

Implemented in AMP::LinearAlgebra::CommSelfVariable, AMP::LinearAlgebra::CommVariable, AMP::LinearAlgebra::MeshVariable, AMP::LinearAlgebra::MeshIteratorVariable, and AMP::LinearAlgebra::StridedVariable.

◆ getID()

virtual uint64_t AMP::LinearAlgebra::Variable::getID ( ) const

virtualinherited

Get a unique id hash for the vector.

Reimplemented in AMP::LinearAlgebra::CommSelfVariable, AMP::LinearAlgebra::CommVariable, AMP::LinearAlgebra::MeshVariable, and AMP::LinearAlgebra::MeshIteratorVariable.

◆ getName()

auto & AMP::LinearAlgebra::Variable::getName ( ) const

inlineinherited

A function that returns the name of a variable.

This gives access to the name

Definition at line 74 of file Variable.h.

References AMP::LinearAlgebra::Variable::d_VariableName.

◆ getSubsetDOF()

virtual std::shared_ptr< AMP::Discretization::DOFManager > AMP::LinearAlgebra::SubsetVariable::getSubsetDOF ( std::shared_ptr< AMP::Discretization::DOFManager > manager ) const

pure virtual

Return a DOFManager that describes the subset.

Returns: The DOFManager

Parameters

[in] manager The DOF manager we want to subset

Implemented in AMP::LinearAlgebra::CommSelfVariable, AMP::LinearAlgebra::CommVariable, AMP::LinearAlgebra::MeshVariable, AMP::LinearAlgebra::MeshIteratorVariable, and AMP::LinearAlgebra::StridedVariable.

◆ getUnits()

virtual const Units & AMP::LinearAlgebra::Variable::getUnits ( ) const

virtualinherited

Get the units of this variable.

◆ operator!=()

bool AMP::LinearAlgebra::Variable::operator!= ( const Variable & rhs ) const

inherited

Inverse of ==.

This function performs an equality check and negates it.

Parameters

rhs	Variable to compare

◆ operator==()

virtual bool AMP::LinearAlgebra::Variable::operator== ( const Variable & rhs ) const

virtualinherited

Compares two variables for equality.

This operation compares the names.

Parameters

rhs	Variable to compare

Reimplemented in AMP::LinearAlgebra::MultiVariable.

◆ registerChildObjects()

virtual void AMP::LinearAlgebra::Variable::registerChildObjects ( AMP::IO::RestartManager * manager ) const

virtualinherited

Register any child objects.

This function will register child objects with the manager

Parameters

manager Restart manager

Reimplemented in AMP::LinearAlgebra::MultiVariable.

◆ setUnits()

virtual void AMP::LinearAlgebra::Variable::setUnits ( const Units & u )

virtualinherited

Set the units of this variable.

Reimplemented in AMP::LinearAlgebra::MultiVariable.

◆ shared_from_this() [1/2]

std::shared_ptr< Variable > AMP::enable_shared_from_this< Variable >::shared_from_this ( )

inlineinherited

Definition at line 28 of file enable_shared_from_this.h.

◆ shared_from_this() [2/2]

std::shared_ptr< const Variable > AMP::enable_shared_from_this< Variable >::shared_from_this ( ) const

inlineinherited

Definition at line 46 of file enable_shared_from_this.h.

◆ view() [1/2]

virtual Vector::const_shared_ptr AMP::LinearAlgebra::SubsetVariable::view ( Vector::const_shared_ptr ) const

virtual

This vector is a subset of an AMP Vector.

Given an AMP Vector, this will create a view of a subset of the vector. For instance, if \(\mathbf{a} = \{ a_0 a_1 a_2 \ldots a_n\}\), and \(S\) is a set of non-negative integers \(( s_0 s_1 \ldots s_m )\) such that \(0 \le s_i \le n\), then the SubsetVector will be the vector \(\mathbf{a}_S = \{ a_{s_0} a_{s_1} a_{s_2} \ldots a_{s_m}\} \).

Since this is a view, any change to vec2 will be reflected on vec1 and vice versa. vec2 is a sparse vector, with a mapping of new index to old. vec3, on the other hand, is a dense vector without an index. If a lot of computation is necessary on the sparse vector, the data can be copied in and out:

// Subset the vector to make a sparse vector.
vec2 = AMP::SubsetVector( vec1 , subsetVar )
 
// Copy the sparse vector data to a dense vector
vec3.copyVector( vec2 );
 
// Perform whatever math
performComputation( vec3 );
 
// Copy data back to vec2, and, consequently, vec1
vec2.copyVector( vec3 );

Reimplemented in AMP::LinearAlgebra::CommSelfVariable.

◆ view() [2/2]

virtual Vector::shared_ptr AMP::LinearAlgebra::SubsetVariable::view ( Vector::shared_ptr ) const

virtual

This vector is a subset of an AMP Vector.

Given an AMP Vector, this will create a view of a subset of the vector. For instance, if \(\mathbf{a} = \{ a_0 a_1 a_2 \ldots a_n\}\), and \(S\) is a set of non-negative integers \(( s_0 s_1 \ldots s_m )\) such that \(0 \le s_i \le n\), then the SubsetVector will be the vector \(\mathbf{a}_S = \{ a_{s_0} a_{s_1} a_{s_2} \ldots a_{s_m}\} \).

Since this is a view, any change to vec2 will be reflected on vec1 and vice versa. vec2 is a sparse vector, with a mapping of new index to old. vec3, on the other hand, is a dense vector without an index. If a lot of computation is necessary on the sparse vector, the data can be copied in and out:

// Subset the vector to make a sparse vector.
vec2 = AMP::SubsetVector( vec1 , subsetVar )
 
// Copy the sparse vector data to a dense vector
vec3.copyVector( vec2 );
 
// Perform whatever math
performComputation( vec3 );
 
// Copy data back to vec2, and, consequently, vec1
vec2.copyVector( vec3 );

Reimplemented in AMP::LinearAlgebra::CommSelfVariable, and AMP::LinearAlgebra::CommSelfVariable.

◆ writeRestart()

void AMP::LinearAlgebra::SubsetVariable::writeRestart ( int64_t fid ) const

overridevirtual

Write restart data to file.

This function will the variable to an HDF5 file

Parameters

fid	File identifier to write

Reimplemented from AMP::LinearAlgebra::Variable.

Member Data Documentation

◆ d_Units

AMP::Units AMP::LinearAlgebra::Variable::d_Units

protectedinherited

The units this variable is measured in.

Definition at line 155 of file Variable.h.

◆ d_VariableName

std::string AMP::LinearAlgebra::Variable::d_VariableName

protectedinherited

A name given to the variable.

Variables have names for easy identification. For instance, some variables are called displacement, concentration, search direction, etc.

Definition at line 151 of file Variable.h.

Referenced by AMP::LinearAlgebra::Variable::getName().

◆ weak_ptr_

std::weak_ptr<Variable > AMP::enable_shared_from_this< Variable >::weak_ptr_

mutableprotectedinherited

Definition at line 69 of file enable_shared_from_this.h.

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

src/vectors/SubsetVariable.h

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SubsetVariable() [1/2]

◆ SubsetVariable() [2/2]

Member Function Documentation

◆ className()

◆ clone() [1/2]

◆ clone() [2/2]

◆ createVectorSelector()

◆ getComm()

◆ getID()

◆ getName()

◆ getSubsetDOF()

◆ getUnits()

◆ operator!=()

◆ operator==()

◆ registerChildObjects()

◆ setUnits()

◆ shared_from_this() [1/2]

◆ shared_from_this() [2/2]

◆ view() [1/2]

◆ view() [2/2]

◆ writeRestart()

Member Data Documentation

◆ d_Units

◆ d_VariableName

◆ weak_ptr_