#include <MemorySpaceMigrationOperator.h>

Inheritance diagram for AMP::Operator::MemorySpaceMigrationOperator:

Public Types
typedef std::shared_ptr< AMP::Operator::Operator >	shared_ptr

Public Member Functions
void	apply (std::shared_ptr< const AMP::LinearAlgebra::Vector > u, std::shared_ptr< AMP::LinearAlgebra::Vector > f) override

std::shared_ptr< AMP::LinearAlgebra::Vector >	createInputVector () const override
	Get a input vector ( For \(\mathbf{A(x)}\), \(\mathbf{x}\) is a input vector )

std::shared_ptr< AMP::LinearAlgebra::Vector >	createOutputVector () const override
	Get an output vector ( For \(\mathbf{y=A(x)}\), \(\mathbf{y}\) is an output vector )

std::shared_ptr< AMP::LinearAlgebra::Variable >	getInputVariable () const override
	Return the input variable.

AMP::Utilities::MemoryType	getMemoryLocation () const

std::shared_ptr< AMP::Mesh::Mesh >	getMesh ()
	Return the mesh.

std::shared_ptr< const AMP::Mesh::Mesh >	getMesh () const
	Return the mesh.

std::shared_ptr< AMP::LinearAlgebra::Variable >	getOutputVariable () const override
	Return the output variable.

std::shared_ptr< OperatorParameters >	getParameters (const std::string &type, std::shared_ptr< const AMP::LinearAlgebra::Vector > u, std::shared_ptr< OperatorParameters > params=nullptr) override

bool	isValidVector (std::shared_ptr< const AMP::LinearAlgebra::Vector >) override
	given a vector return whether it is valid or not

void	makeConsistent (std::shared_ptr< AMP::LinearAlgebra::Vector > vec) override

	MemorySpaceMigrationOperator (std::shared_ptr< const OperatorParameters > params)
	Constructor.

	MemorySpaceMigrationOperator (void)
	Default constructor.

void	reInitializeVector (std::shared_ptr< AMP::LinearAlgebra::Vector >) override

void	reset (std::shared_ptr< const OperatorParameters > params) override

void	residual (std::shared_ptr< const AMP::LinearAlgebra::Vector > f, std::shared_ptr< const AMP::LinearAlgebra::Vector > u, std::shared_ptr< AMP::LinearAlgebra::Vector > r) override

std::shared_ptr< AMP::LinearAlgebra::VectorSelector >	selectInputVector () const override
	Return the selector for input vectors.

std::shared_ptr< AMP::LinearAlgebra::VectorSelector >	selectOutputVector () const override
	Return the selector for output vectors.

void	setDebugPrintInfoLevel (int level) override

std::shared_ptr< AMP::LinearAlgebra::Vector >	subsetInputVector (std::shared_ptr< AMP::LinearAlgebra::Vector > vec) const
	Subset input vector.

std::shared_ptr< const AMP::LinearAlgebra::Vector >	subsetInputVector (std::shared_ptr< const AMP::LinearAlgebra::Vector > vec) const
	Subset input vector.

std::shared_ptr< AMP::LinearAlgebra::Vector >	subsetOutputVector (std::shared_ptr< AMP::LinearAlgebra::Vector > vec) const
	Subset output vector.

std::shared_ptr< const AMP::LinearAlgebra::Vector >	subsetOutputVector (std::shared_ptr< const AMP::LinearAlgebra::Vector > vec) const
	Subset output vector.

std::string	type () const override
	Return the name of the operator.

virtual	~MemorySpaceMigrationOperator ()
	Destructor.

Public Attributes
std::shared_ptr< AMP::LinearAlgebra::Vector >	d_inputVec
	scratch space for input vectors

bool	d_migrate_data

std::shared_ptr< AMP::LinearAlgebra::Vector >	d_outputVec
	scratch space for output vectors

std::shared_ptr< Operator >	d_pOperator
	Operator being adapted for memory operations.

std::shared_ptr< AMP::LinearAlgebra::Vector >	d_resVec
	scratch space for residuals

Protected Member Functions
void	getBackendFromInput (std::shared_ptr< AMP::Database > db)

virtual std::shared_ptr< OperatorParameters >	getJacobianParameters (std::shared_ptr< const AMP::LinearAlgebra::Vector >)

void	setMemoryAndBackendParameters (std::shared_ptr< AMP::Database > db)

Protected Attributes
AMP::Utilities::Backend	d_backend = AMP::Utilities::Backend::Serial

int	d_iDebugPrintInfoLevel = 0

int	d_iObject_id

AMP::Utilities::MemoryType	d_memory_location = AMP::Utilities::MemoryType::none

std::shared_ptr< AMP::Mesh::Mesh >	d_Mesh

Static Protected Attributes
static int	d_iInstance_id

Detailed Description

This operator serves as an adaptor for an existing operator, Op, It accepts vectors potentially in another memory address space, copies them to the address space of Op so that Op can be used without modification. A version of this Operator derived from LinearOperator also exists for use with LinearOperators

Definition at line 14 of file MemorySpaceMigrationOperator.h.

Member Typedef Documentation

◆ shared_ptr

typedef std::shared_ptr<AMP::Operator::Operator> AMP::Operator::Operator::shared_ptr

inherited

Definition at line 29 of file Operator.h.

Constructor & Destructor Documentation

◆ MemorySpaceMigrationOperator() [1/2]

AMP::Operator::MemorySpaceMigrationOperator::MemorySpaceMigrationOperator ( void )

Default constructor.

◆ MemorySpaceMigrationOperator() [2/2]

AMP::Operator::MemorySpaceMigrationOperator::MemorySpaceMigrationOperator ( std::shared_ptr< const OperatorParameters > params )

explicit

Constructor.

◆ ~MemorySpaceMigrationOperator()

virtual AMP::Operator::MemorySpaceMigrationOperator::~MemorySpaceMigrationOperator ( )

inlinevirtual

Destructor.

Definition at line 24 of file MemorySpaceMigrationOperator.h.

Member Function Documentation

◆ apply()

void AMP::Operator::MemorySpaceMigrationOperator::apply	(	std::shared_ptr< const AMP::LinearAlgebra::Vector >	u,
		std::shared_ptr< AMP::LinearAlgebra::Vector >	f
	)

overridevirtual

This base class can not give a meaningful definition of apply. See the derived classes for how they define apply. Each operator is free to define apply in a way that is appropriate for that operator.

Parameters

u	shared pointer to const input vector u
f	shared pointer to output vector storing result of applying this operator

Implements AMP::Operator::Operator.

◆ createInputVector()

std::shared_ptr< AMP::LinearAlgebra::Vector > AMP::Operator::MemorySpaceMigrationOperator::createInputVector ( ) const

overridevirtual

Get a input vector ( For \(\mathbf{A(x)}\), \(\mathbf{x}\) is a input vector )

Returns: A newly created input vector

Reimplemented from AMP::Operator::Operator.

◆ createOutputVector()

std::shared_ptr< AMP::LinearAlgebra::Vector > AMP::Operator::MemorySpaceMigrationOperator::createOutputVector ( ) const

overridevirtual

Get an output vector ( For \(\mathbf{y=A(x)}\), \(\mathbf{y}\) is an output vector )

Returns: A newly created output vector

Reimplemented from AMP::Operator::Operator.

◆ getBackendFromInput()

void AMP::Operator::Operator::getBackendFromInput ( std::shared_ptr< AMP::Database > db )

protectedinherited

◆ getInputVariable()

std::shared_ptr< AMP::LinearAlgebra::Variable > AMP::Operator::MemorySpaceMigrationOperator::getInputVariable ( ) const

overridevirtual

Return the input variable.

Reimplemented from AMP::Operator::Operator.

◆ getJacobianParameters()

virtual std::shared_ptr< OperatorParameters > AMP::Operator::Operator::getJacobianParameters ( std::shared_ptr< const AMP::LinearAlgebra::Vector > )

inlineprotectedvirtualinherited

This function returns a OperatorParameters object constructed by the operator which contains parameters from which new Jacobian operators can be created. Returning a parameter object instead of an Operator itself is meant to give users more flexibility.

Definition at line 180 of file Operator.h.

◆ getMemoryLocation()

AMP::Utilities::MemoryType AMP::Operator::Operator::getMemoryLocation ( ) const

inlineinherited

Definition at line 89 of file Operator.h.

References AMP::Operator::Operator::d_memory_location.

◆ getMesh() [1/2]

std::shared_ptr< AMP::Mesh::Mesh > AMP::Operator::Operator::getMesh ( )

inlineinherited

Return the mesh.

Definition at line 149 of file Operator.h.

References AMP::Operator::Operator::d_Mesh.

◆ getMesh() [2/2]

std::shared_ptr< const AMP::Mesh::Mesh > AMP::Operator::Operator::getMesh ( ) const

inlineinherited

Return the mesh.

Definition at line 152 of file Operator.h.

References AMP::Operator::Operator::d_Mesh.

◆ getOutputVariable()

std::shared_ptr< AMP::LinearAlgebra::Variable > AMP::Operator::MemorySpaceMigrationOperator::getOutputVariable ( ) const

overridevirtual

Return the output variable.

Reimplemented from AMP::Operator::Operator.

◆ getParameters()

std::shared_ptr< OperatorParameters > AMP::Operator::MemorySpaceMigrationOperator::getParameters	(	const std::string &	type,
		std::shared_ptr< const AMP::LinearAlgebra::Vector >	u,
		std::shared_ptr< OperatorParameters >	params = `nullptr`
	)

overridevirtual

This function returns a OperatorParameters object constructed by the operator which contains parameters from which new operators can be created. Returning a parameter object instead of an Operator itself is meant to give users more flexibility. Examples of how this functionality might be used would be the construction of Jacobian, frozen Jacobian, preconditioner approximations to the Jacobian, adjoint operators etc

Parameters

type	std:string specifying type of return operator parameters being requested. Currently the valid option is Jacobian
u	const pointer to current solution vector
params	pointer to additional parameters that might be required to construct the return parameters

Reimplemented from AMP::Operator::Operator.

◆ isValidVector()

bool AMP::Operator::MemorySpaceMigrationOperator::isValidVector ( std::shared_ptr< const AMP::LinearAlgebra::Vector > )

overridevirtual

given a vector return whether it is valid or not

Reimplemented from AMP::Operator::Operator.

◆ makeConsistent()

void AMP::Operator::MemorySpaceMigrationOperator::makeConsistent ( std::shared_ptr< AMP::LinearAlgebra::Vector > vec )

overridevirtual

interface used to make a vector consistent in an operator defined way. An example of where an operator is required to make a vector consistent is in the context of AMR where ghost values on coarse-fine interfaces are filled in an operator dependent way. The default implementation is to simply call the vector makeConsistent(SET)

Reimplemented from AMP::Operator::Operator.

◆ reInitializeVector()

void AMP::Operator::MemorySpaceMigrationOperator::reInitializeVector ( std::shared_ptr< AMP::LinearAlgebra::Vector > )

overridevirtual

re-initialize a vector, e.g. after a regrid operation has happened. This is useful for example when numerical overshoots or undershoots have happened due to interpolation for example The default is a null op

Reimplemented from AMP::Operator::Operator.

◆ reset()

void AMP::Operator::MemorySpaceMigrationOperator::reset ( std::shared_ptr< const OperatorParameters > params )

overridevirtual

This function is useful for re-initializing/updating an operator

Parameters

params parameter object containing parameters to change

Reimplemented from AMP::Operator::Operator.

◆ residual()

void AMP::Operator::MemorySpaceMigrationOperator::residual	(	std::shared_ptr< const AMP::LinearAlgebra::Vector >	f,
		std::shared_ptr< const AMP::LinearAlgebra::Vector >	u,
		std::shared_ptr< AMP::LinearAlgebra::Vector >	r
	)

overridevirtual

Default base class implementation of the residual: f-L(u)

Parameters

f	shared pointer to const vector rhs
u	shared pointer to const vector u
r	shared pointer to vector residual

Reimplemented from AMP::Operator::Operator.

◆ selectInputVector()

std::shared_ptr< AMP::LinearAlgebra::VectorSelector > AMP::Operator::MemorySpaceMigrationOperator::selectInputVector ( ) const

overridevirtual

Return the selector for input vectors.

Reimplemented from AMP::Operator::Operator.

◆ selectOutputVector()

std::shared_ptr< AMP::LinearAlgebra::VectorSelector > AMP::Operator::MemorySpaceMigrationOperator::selectOutputVector ( ) const

overridevirtual

Return the selector for output vectors.

Reimplemented from AMP::Operator::Operator.

◆ setDebugPrintInfoLevel()

void AMP::Operator::MemorySpaceMigrationOperator::setDebugPrintInfoLevel ( int level )

overridevirtual

Specify level of diagnostic information printed during iterations.

Parameters

level zero prints none or minimal information, higher numbers provide increasingly verbose debugging information.

Reimplemented from AMP::Operator::Operator.

◆ setMemoryAndBackendParameters()

void AMP::Operator::Operator::setMemoryAndBackendParameters ( std::shared_ptr< AMP::Database > db )

protectedinherited

◆ subsetInputVector() [1/2]

std::shared_ptr< AMP::LinearAlgebra::Vector > AMP::Operator::Operator::subsetInputVector ( std::shared_ptr< AMP::LinearAlgebra::Vector > vec ) const

inherited

Subset input vector.

◆ subsetInputVector() [2/2]

std::shared_ptr< const AMP::LinearAlgebra::Vector > AMP::Operator::Operator::subsetInputVector ( std::shared_ptr< const AMP::LinearAlgebra::Vector > vec ) const

inherited

Subset input vector.

◆ subsetOutputVector() [1/2]

std::shared_ptr< AMP::LinearAlgebra::Vector > AMP::Operator::Operator::subsetOutputVector ( std::shared_ptr< AMP::LinearAlgebra::Vector > vec ) const

inherited

Subset output vector.

◆ subsetOutputVector() [2/2]

std::shared_ptr< const AMP::LinearAlgebra::Vector > AMP::Operator::Operator::subsetOutputVector ( std::shared_ptr< const AMP::LinearAlgebra::Vector > vec ) const

inherited

Subset output vector.

◆ type()

std::string AMP::Operator::MemorySpaceMigrationOperator::type ( ) const

inlineoverridevirtual

Return the name of the operator.

Implements AMP::Operator::Operator.

Definition at line 27 of file MemorySpaceMigrationOperator.h.

Member Data Documentation

◆ d_backend

AMP::Utilities::Backend AMP::Operator::Operator::d_backend = AMP::Utilities::Backend::Serial

protectedinherited

Definition at line 197 of file Operator.h.

◆ d_iDebugPrintInfoLevel

int AMP::Operator::Operator::d_iDebugPrintInfoLevel = 0

protectedinherited

Definition at line 187 of file Operator.h.

Referenced by AMP::Operator::Operator::setDebugPrintInfoLevel().

◆ d_iInstance_id

int AMP::Operator::Operator::d_iInstance_id

staticprotectedinherited

Definition at line 191 of file Operator.h.

◆ d_inputVec

std::shared_ptr<AMP::LinearAlgebra::Vector> AMP::Operator::MemorySpaceMigrationOperator::d_inputVec

scratch space for input vectors

Definition at line 128 of file MemorySpaceMigrationOperator.h.

◆ d_iObject_id

int AMP::Operator::Operator::d_iObject_id

protectedinherited

Definition at line 189 of file Operator.h.

◆ d_memory_location

AMP::Utilities::MemoryType AMP::Operator::Operator::d_memory_location = AMP::Utilities::MemoryType::none

protectedinherited

Definition at line 195 of file Operator.h.

Referenced by AMP::Operator::Operator::getMemoryLocation().

◆ d_Mesh

std::shared_ptr<AMP::Mesh::Mesh> AMP::Operator::Operator::d_Mesh

protectedinherited

Definition at line 193 of file Operator.h.

Referenced by AMP::Operator::Operator::getMesh(), AMP::Operator::Operator::getMesh(), and AMP::Operator::ContactResidualCorrection::setMasterMesh().

◆ d_migrate_data

bool AMP::Operator::MemorySpaceMigrationOperator::d_migrate_data

Definition at line 125 of file MemorySpaceMigrationOperator.h.

◆ d_outputVec

std::shared_ptr<AMP::LinearAlgebra::Vector> AMP::Operator::MemorySpaceMigrationOperator::d_outputVec

scratch space for output vectors

Definition at line 130 of file MemorySpaceMigrationOperator.h.

◆ d_pOperator

std::shared_ptr<Operator> AMP::Operator::MemorySpaceMigrationOperator::d_pOperator

Operator being adapted for memory operations.

Definition at line 135 of file MemorySpaceMigrationOperator.h.

◆ d_resVec

std::shared_ptr<AMP::LinearAlgebra::Vector> AMP::Operator::MemorySpaceMigrationOperator::d_resVec

scratch space for residuals

Definition at line 132 of file MemorySpaceMigrationOperator.h.

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

src/operators/MemorySpaceMigrationOperator.h

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Typedef Documentation

◆ shared_ptr

Constructor & Destructor Documentation

◆ MemorySpaceMigrationOperator() [1/2]

◆ MemorySpaceMigrationOperator() [2/2]

◆ ~MemorySpaceMigrationOperator()

Member Function Documentation

◆ apply()

◆ createInputVector()

◆ createOutputVector()

◆ getBackendFromInput()

◆ getInputVariable()

◆ getJacobianParameters()

◆ getMemoryLocation()

◆ getMesh() [1/2]

◆ getMesh() [2/2]

◆ getOutputVariable()

◆ getParameters()

◆ isValidVector()

◆ makeConsistent()

◆ reInitializeVector()

◆ reset()

◆ residual()

◆ selectInputVector()

◆ selectOutputVector()

◆ setDebugPrintInfoLevel()

◆ setMemoryAndBackendParameters()

◆ subsetInputVector() [1/2]

◆ subsetInputVector() [2/2]

◆ subsetOutputVector() [1/2]

◆ subsetOutputVector() [2/2]

◆ type()

Member Data Documentation

◆ d_backend

◆ d_iDebugPrintInfoLevel

◆ d_iInstance_id

◆ d_inputVec

◆ d_iObject_id

◆ d_memory_location

◆ d_Mesh

◆ d_migrate_data

◆ d_outputVec

◆ d_pOperator

◆ d_resVec