A class that allows for overlapped communication. More...

#include <AsynchronousOperator.h>

Inheritance diagram for AMP::Operator::AsynchronousOperator:

[legend]

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

Public Member Functions
virtual void	apply (AMP::LinearAlgebra::Vector::const_shared_ptr u, AMP::LinearAlgebra::Vector::shared_ptr f) override
	Apply operation.

virtual void	apply (std::shared_ptr< const AMP::LinearAlgebra::Vector > u, std::shared_ptr< AMP::LinearAlgebra::Vector > f)=0

virtual void	applyFinish (AMP::LinearAlgebra::Vector::const_shared_ptr u, AMP::LinearAlgebra::Vector::shared_ptr f)=0
	Finish a communicative apply operation.

virtual void	applyStart (AMP::LinearAlgebra::Vector::const_shared_ptr u, AMP::LinearAlgebra::Vector::shared_ptr f)=0
	Start a communicative apply operation.

	AsynchronousOperator (std::shared_ptr< const OperatorParameters > params)

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

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

virtual std::shared_ptr< AMP::LinearAlgebra::Variable >	getInputVariable () const
	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.

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

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

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

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

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

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

virtual 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)

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

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

virtual void	setDebugPrintInfoLevel (int level)

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	~AsynchronousOperator ()

Protected Member Functions
std::vector< AMP_MPI::Request >::iterator	beginRequests ()
	Return an iterator to the first MPI_Request.

void	clearRequests ()
	Clear requests.

std::vector< AMP_MPI::Request >::iterator	endRequests ()
	Return an iterator to one past the end of the list of requests.

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

template<typename T >
const T *	getBufferToAvoidDebugVectorCrashing (const std::vector< T > &in)
	Functions to allow std::vector to be used in MPI communications when empty.

template<typename T >
T *	getBufferToAvoidDebugVectorCrashing (std::vector< T > &in)
	Functions to allow std::vector to be used in MPI communications when empty.

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

AMP_MPI::Request &	getRequest (size_t i)
	Return a specific MPI_Request.

void	reserveRequests (size_t i)
	Reserve a number of MPI_Requests for use.

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

void	waitForAllRequests ()
	Wait for all requests to complete.

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

std::vector< AMP_MPI::Request >	d_RequestList
	A list of MPI_Requests for use in derived classes.

Static Protected Attributes
static int	d_iInstance_id

Detailed Description

A class that allows for overlapped communication.

Definition at line 17 of file AsynchronousOperator.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

◆ AsynchronousOperator()

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

explicit

◆ ~AsynchronousOperator()

virtual AMP::Operator::AsynchronousOperator::~AsynchronousOperator ( )

virtual

Member Function Documentation

◆ apply() [1/2]

virtual void AMP::Operator::AsynchronousOperator::apply	(	AMP::LinearAlgebra::Vector::const_shared_ptr	u,
		AMP::LinearAlgebra::Vector::shared_ptr	f
	)

overridevirtual

Apply operation.

The apply opertion for an asyncronous operator simply calls applyStart and applyFinish.

Parameters

[in]	u	An input vector
[out]	f	An output vector

Reimplemented in AMP::Operator::AsyncMapOperator, and AMP::Operator::StridedZAxisMap.

◆ apply() [2/2]

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

pure virtualinherited

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

Implemented in AMP::Operator::RadDifOp, AMP::Operator::RadDifOpPJac, AMP::Operator::FunctionOperator, AMP::Operator::MemorySpaceMigrationLinearOperator, and AMP::Operator::MemorySpaceMigrationOperator.

◆ applyFinish()

virtual void AMP::Operator::AsynchronousOperator::applyFinish	(	AMP::LinearAlgebra::Vector::const_shared_ptr	u,
		AMP::LinearAlgebra::Vector::shared_ptr	f
	)

pure virtual

Finish a communicative apply operation.

The specific meaning of applyFinish will vary depending on the operator, but the intended purpose is to finish non-blocking communication and any remaining operations for the vector

Parameters

[in]	u	An input vector
[out]	f	An output vector

Implemented in AMP::Operator::Map3to1to3, AMP::Operator::NodeToNodeMap, AMP::Operator::SubchannelToCladMap, and AMP::Operator::CladToSubchannelMap.

◆ applyStart()

virtual void AMP::Operator::AsynchronousOperator::applyStart	(	AMP::LinearAlgebra::Vector::const_shared_ptr	u,
		AMP::LinearAlgebra::Vector::shared_ptr	f
	)

pure virtual

Start a communicative apply operation.

The specific meaning of applyStart will vary depending on the operator, but the intended purpose is to start non-blocking communication.

Parameters

[in]	u	An input vector
[out]	f	An output vector

Implemented in AMP::Operator::Map3to1to3, AMP::Operator::NodeToNodeMap, AMP::Operator::SubchannelToCladMap, and AMP::Operator::CladToSubchannelMap.

◆ beginRequests()

std::vector< AMP_MPI::Request >::iterator AMP::Operator::AsynchronousOperator::beginRequests ( )

protected

Return an iterator to the first MPI_Request.

Returns: The iterator

◆ clearRequests()

void AMP::Operator::AsynchronousOperator::clearRequests ( )

protected

Clear requests.

◆ createInputVector()

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

virtualinherited

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

Returns: A newly created input vector

Reimplemented in AMP::Operator::IdentityOperator, AMP::Operator::LinearOperator, AMP::Operator::MemorySpaceMigrationLinearOperator, AMP::Operator::MemorySpaceMigrationOperator, AMP::Operator::BDFRadDifOpPJac, AMP::Operator::RadDifOp, and AMP::Operator::RadDifOpPJac.

◆ createOutputVector()

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

virtualinherited

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

Returns: A newly created output vector

Reimplemented in AMP::Operator::IdentityOperator, AMP::Operator::LinearOperator, AMP::Operator::MemorySpaceMigrationLinearOperator, and AMP::Operator::MemorySpaceMigrationOperator.

◆ endRequests()

std::vector< AMP_MPI::Request >::iterator AMP::Operator::AsynchronousOperator::endRequests ( )

protected

Return an iterator to one past the end of the list of requests.

Returns: The iterator

◆ getBackendFromInput()

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

protectedinherited

◆ getBufferToAvoidDebugVectorCrashing() [1/2]

template<typename T >

const T * AMP::Operator::AsynchronousOperator::getBufferToAvoidDebugVectorCrashing ( const std::vector< T > & in )

inlineprotected

Functions to allow std::vector to be used in MPI communications when empty.

Template Parameters

T	The type of buffer to translate

Parameters

[in] in Buffer in a std::vector

Returns: Buffer of type T

Definition at line 73 of file AsynchronousOperator.h.

◆ getBufferToAvoidDebugVectorCrashing() [2/2]

template<typename T >

T * AMP::Operator::AsynchronousOperator::getBufferToAvoidDebugVectorCrashing ( std::vector< T > & in )

inlineprotected

Functions to allow std::vector to be used in MPI communications when empty.

Template Parameters

T	The type of buffer to translate

Parameters

[in] in Buffer in a std::vector

Returns: Buffer of type T

Definition at line 59 of file AsynchronousOperator.h.

◆ getInputVariable()

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

inlinevirtualinherited

Return the input variable.

Definition at line 106 of file Operator.h.

◆ 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()

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

inlinevirtualinherited

Return the output variable.

Definition at line 100 of file Operator.h.

◆ getParameters()

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

virtualinherited

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 in AMP::Operator::IdentityOperator, AMP::Operator::MemorySpaceMigrationLinearOperator, and AMP::Operator::MemorySpaceMigrationOperator.

◆ getRequest()

AMP_MPI::Request & AMP::Operator::AsynchronousOperator::getRequest ( size_t i )

protected

Return a specific MPI_Request.

Returns: The request

◆ isValidVector()

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

inlinevirtualinherited

given a vector return whether it is valid or not

Reimplemented in AMP::Operator::BDFRadDifOp, AMP::Operator::RadDifOp, AMP::Operator::ColumnOperator, AMP::Operator::CoupledOperator, AMP::TimeIntegrator::TimeOperator, AMP::Operator::MemorySpaceMigrationLinearOperator, and AMP::Operator::MemorySpaceMigrationOperator.

Definition at line 146 of file Operator.h.

◆ makeConsistent()

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

virtualinherited

virtual 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 in AMP::Operator::MemorySpaceMigrationLinearOperator, AMP::Operator::MemorySpaceMigrationOperator, and AMP::TimeIntegrator::TimeOperator.

◆ reInitializeVector()

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

inlinevirtualinherited

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 in AMP::TimeIntegrator::TimeOperator, AMP::Operator::MemorySpaceMigrationLinearOperator, and AMP::Operator::MemorySpaceMigrationOperator.

Definition at line 167 of file Operator.h.

◆ reserveRequests()

void AMP::Operator::AsynchronousOperator::reserveRequests ( size_t i )

protected

Reserve a number of MPI_Requests for use.

Parameters

[in] i The number of MPI_Requests that will be used

◆ reset()

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

virtualinherited

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

Parameters

params parameter object containing parameters to change

Referenced by AMP::Operator::FirstOperator::FirstOperator(), and AMP::Operator::SecondOperator::SecondOperator().

◆ residual()

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

virtualinherited

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 in AMP::Solver::AMG::HasDeferConsistency< AMP::Operator::LinearOperator >, AMP::Operator::MemorySpaceMigrationLinearOperator, AMP::Operator::MemorySpaceMigrationOperator, AMP::TimeIntegrator::IDATimeOperator, and AMP::TimeIntegrator::TimeOperator.

◆ selectInputVector()

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

virtualinherited

Return the selector for input vectors.

Reimplemented in AMP::Operator::MemorySpaceMigrationLinearOperator, AMP::Operator::MemorySpaceMigrationOperator, AMP::Operator::FlowFrapconJacobian, AMP::Operator::FlowFrapconOperator, AMP::Operator::SubchannelFourEqLinearOperator, and AMP::Operator::SubchannelFourEqNonlinearOperator.

◆ selectOutputVector()

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

virtualinherited

Return the selector for output vectors.

Reimplemented in AMP::Operator::MemorySpaceMigrationLinearOperator, AMP::Operator::MemorySpaceMigrationOperator, AMP::Operator::FlowFrapconJacobian, AMP::Operator::FlowFrapconOperator, AMP::Operator::SubchannelFourEqLinearOperator, and AMP::Operator::SubchannelFourEqNonlinearOperator.

◆ setDebugPrintInfoLevel()

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

inlinevirtualinherited

Specify level of diagnostic information printed during iterations.

Parameters

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

Reimplemented in AMP::Operator::MemorySpaceMigrationLinearOperator, and AMP::Operator::MemorySpaceMigrationOperator.

Definition at line 97 of file Operator.h.

References AMP::Operator::Operator::d_iDebugPrintInfoLevel.

◆ 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::AsynchronousOperator::type ( ) const

inlineoverridevirtual

Return the name of the operator.

Implements AMP::Operator::Operator.

Reimplemented in AMP::Operator::AsyncMapOperator, AMP::Operator::CladToSubchannelMap, AMP::Operator::ScalarN2GZAxisMap, AMP::Operator::SubchannelToCladGPMap, AMP::Operator::Map3to1to3, AMP::Operator::NodeToNodeMap, AMP::Operator::ScalarZAxisMap, AMP::Operator::StridedZAxisMap, and AMP::Operator::SubchannelToCladMap.

Definition at line 88 of file AsynchronousOperator.h.

◆ waitForAllRequests()

void AMP::Operator::AsynchronousOperator::waitForAllRequests ( )

protected

Wait for all requests to complete.

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_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_RequestList

std::vector<AMP_MPI::Request> AMP::Operator::AsynchronousOperator::d_RequestList

protected

A list of MPI_Requests for use in derived classes.

Definition at line 22 of file AsynchronousOperator.h.

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

src/operators/AsynchronousOperator.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Typedef Documentation

◆ shared_ptr

Constructor & Destructor Documentation

◆ AsynchronousOperator()

◆ ~AsynchronousOperator()

Member Function Documentation

◆ apply() [1/2]

◆ apply() [2/2]

◆ applyFinish()

◆ applyStart()

◆ beginRequests()

◆ clearRequests()

◆ createInputVector()

◆ createOutputVector()

◆ endRequests()

◆ getBackendFromInput()

◆ getBufferToAvoidDebugVectorCrashing() [1/2]

◆ getBufferToAvoidDebugVectorCrashing() [2/2]

◆ getInputVariable()

◆ getJacobianParameters()

◆ getMemoryLocation()

◆ getMesh() [1/2]

◆ getMesh() [2/2]

◆ getOutputVariable()

◆ getParameters()

◆ getRequest()

◆ isValidVector()

◆ makeConsistent()

◆ reInitializeVector()

◆ reserveRequests()

◆ reset()

◆ residual()

◆ selectInputVector()

◆ selectOutputVector()

◆ setDebugPrintInfoLevel()

◆ setMemoryAndBackendParameters()

◆ subsetInputVector() [1/2]

◆ subsetInputVector() [2/2]

◆ subsetOutputVector() [1/2]

◆ subsetOutputVector() [2/2]

◆ type()

◆ waitForAllRequests()

Member Data Documentation

◆ d_backend

◆ d_iDebugPrintInfoLevel

◆ d_iInstance_id

◆ d_iObject_id

◆ d_memory_location

◆ d_Mesh

◆ d_RequestList