A column operator of asynchronous operators. The apply method will start the list of operators then finalize the list of operators. More...

#include <AsynchronousColumnOperator.h>

Inheritance diagram for AMP::Operator::AsynchronousColumnOperator:

[legend]

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

Public Member Functions
void	append (std::shared_ptr< Operator > op) override

void	apply (AMP::LinearAlgebra::Vector::const_shared_ptr u, AMP::LinearAlgebra::Vector::shared_ptr f) override
	The apply routine for the column operator calls apply on each of the component operators.

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)
	Finish an apply operation (arguments should match applyStart)

virtual void	applyStart (AMP::LinearAlgebra::Vector::const_shared_ptr u, AMP::LinearAlgebra::Vector::shared_ptr f)
	Start an apply operation.

	AsynchronousColumnOperator ()
	Empty constructor.

	AsynchronousColumnOperator (std::shared_ptr< const OperatorParameters >)
	Default constructor.

auto	begin ()
	Return an iterator to the beginning of the operators.

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 )

auto	end ()
	Return an iterator to the end of the operators.

std::vector< std::shared_ptr< Operator > >	find (const std::string &name)
	Return the operator(s) with the given name/type.

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.

size_t	getNumberOfOperators ()

std::shared_ptr< Operator >	getOperator (size_t i)

const auto &	getOperators ()

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

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

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

bool	isValidVector (std::shared_ptr< const AMP::LinearAlgebra::Vector > u) override
	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 >)

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

void	residual (AMP::LinearAlgebra::Vector::const_shared_ptr f, AMP::LinearAlgebra::Vector::const_shared_ptr u, AMP::LinearAlgebra::Vector::shared_ptr r) override

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.

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

std::vector< std::shared_ptr< Operator > >	d_operators

Static Protected Attributes
static int	d_iInstance_id

Detailed Description

A column operator of asynchronous operators. The apply method will start the list of operators then finalize the list of operators.

Definition at line 11 of file AsynchronousColumnOperator.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

◆ AsynchronousColumnOperator() [1/2]

AMP::Operator::AsynchronousColumnOperator::AsynchronousColumnOperator ( )

explicit

Empty constructor.

◆ AsynchronousColumnOperator() [2/2]

AMP::Operator::AsynchronousColumnOperator::AsynchronousColumnOperator ( std::shared_ptr< const OperatorParameters > )

explicit

Default constructor.

Member Function Documentation

◆ append()

void AMP::Operator::AsynchronousColumnOperator::append ( std::shared_ptr< Operator > op )

overridevirtual

Parameters

op	shared pointer to an operator to append to the existing column of operators

Reimplemented from AMP::Operator::ColumnOperator.

Reimplemented in AMP::Operator::AsyncMapColumnOperator.

◆ apply() [1/2]

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

override

The apply routine for the column operator calls apply on each of the component operators.

◆ 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::AsynchronousColumnOperator::applyFinish	(	AMP::LinearAlgebra::Vector::const_shared_ptr	u,
		AMP::LinearAlgebra::Vector::shared_ptr	f
	)

virtual

Finish an apply operation (arguments should match applyStart)

◆ applyStart()

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

virtual

Start an apply operation.

◆ begin()

auto AMP::Operator::ColumnOperator::begin ( )

inlineinherited

Return an iterator to the beginning of the operators.

Definition at line 87 of file ColumnOperator.h.

References AMP::Operator::ColumnOperator::d_operators.

◆ 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.

◆ end()

auto AMP::Operator::ColumnOperator::end ( )

inlineinherited

Return an iterator to the end of the operators.

Definition at line 90 of file ColumnOperator.h.

References AMP::Operator::ColumnOperator::d_operators.

◆ find()

std::vector< std::shared_ptr< Operator > > AMP::Operator::ColumnOperator::find ( const std::string & name )

inherited

Return the operator(s) with the given name/type.

◆ getBackendFromInput()

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

protectedinherited

◆ getInputVariable()

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

overridevirtualinherited

Return the input variable.

Reimplemented from AMP::Operator::Operator.

Reimplemented in AMP::Operator::CoupledFlowFrapconOperator.

◆ 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.

◆ getNumberOfOperators()

size_t AMP::Operator::ColumnOperator::getNumberOfOperators ( )

inlineinherited

Definition at line 80 of file ColumnOperator.h.

References AMP::Operator::ColumnOperator::d_operators.

◆ getOperator()

std::shared_ptr< Operator > AMP::Operator::ColumnOperator::getOperator ( size_t i )

inlineinherited

Definition at line 82 of file ColumnOperator.h.

References AMP::Operator::ColumnOperator::d_operators.

◆ getOperators()

const auto & AMP::Operator::ColumnOperator::getOperators ( )

inlineinherited

Definition at line 84 of file ColumnOperator.h.

References AMP::Operator::ColumnOperator::d_operators.

◆ getOutputVariable()

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

overridevirtualinherited

returns a MultiVariable object corresponding to the ColumnOperator should be called only after all column operators have been appended. no checks to do this right now.

Reimplemented from AMP::Operator::Operator.

Reimplemented in AMP::Operator::CoupledOperator, and AMP::Operator::CoupledFlowFrapconOperator.

◆ getParameters() [1/2]

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

overrideinherited

A function for computing the information necessary to construct the jacobian.

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

Returns: The parameters required to construct the jacobian.

◆ getParameters() [2/2]

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.

◆ isValidVector()

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

overridevirtualinherited

given a vector return whether it is valid or not

Reimplemented from AMP::Operator::Operator.

Reimplemented in AMP::Operator::CoupledOperator.

◆ 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.

◆ reset()

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

overridevirtualinherited

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

Parameters

params parameter object containing parameters to change

Reimplemented from AMP::Operator::Operator.

Reimplemented in AMP::TimeIntegrator::ColumnTimeOperator, and AMP::Operator::CoupledFlowFrapconOperator.

◆ residual() [1/2]

void AMP::Operator::ColumnOperator::residual	(	AMP::LinearAlgebra::Vector::const_shared_ptr	f,
		AMP::LinearAlgebra::Vector::const_shared_ptr	u,
		AMP::LinearAlgebra::Vector::shared_ptr	r
	)

overrideinherited

Column specific 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

◆ residual() [2/2]

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

inlineoverridevirtual

Return the name of the operator.

Implements AMP::Operator::Operator.

Reimplemented in AMP::Operator::AsyncMapColumnOperator.

Definition at line 21 of file AsynchronousColumnOperator.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_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_operators

std::vector<std::shared_ptr<Operator> > AMP::Operator::ColumnOperator::d_operators

protectedinherited

Definition at line 96 of file ColumnOperator.h.

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

src/operators/AsynchronousColumnOperator.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Typedef Documentation

◆ shared_ptr

Constructor & Destructor Documentation

◆ AsynchronousColumnOperator() [1/2]

◆ AsynchronousColumnOperator() [2/2]

Member Function Documentation

◆ append()

◆ apply() [1/2]

◆ apply() [2/2]

◆ applyFinish()

◆ applyStart()

◆ begin()

◆ createInputVector()

◆ createOutputVector()

◆ end()

◆ find()

◆ getBackendFromInput()

◆ getInputVariable()

◆ getJacobianParameters()

◆ getMemoryLocation()

◆ getMesh() [1/2]

◆ getMesh() [2/2]

◆ getNumberOfOperators()

◆ getOperator()

◆ getOperators()

◆ getOutputVariable()

◆ getParameters() [1/2]

◆ getParameters() [2/2]

◆ isValidVector()

◆ makeConsistent()

◆ reInitializeVector()

◆ reset()

◆ residual() [1/2]

◆ residual() [2/2]

◆ 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_iObject_id

◆ d_memory_location

◆ d_Mesh

◆ d_operators