#include <IdentityOperator.h>

Inheritance diagram for AMP::Operator::IdentityOperator:

[legend]

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

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

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

std::shared_ptr< AMP::LinearAlgebra::Vector >	createInputVector () const override
	Get a right vector ( For \(\mathbf{y}^T\mathbf{Ax}\), \(\mathbf{x}\) is a right vector )

std::shared_ptr< AMP::LinearAlgebra::Vector >	createOutputVector () const override
	Get a left vector ( For \(\mathbf{y}^T\mathbf{Ax}\), \(\mathbf{y}\) is a left vector )

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

virtual std::shared_ptr< AMP::LinearAlgebra::Matrix >	getMatrix ()

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

	IdentityOperator ()
	Constructor. This resets the matrix shared pointer.

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

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

void	reset (std::shared_ptr< const OperatorParameters > params) 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)

virtual void	setInputVariable (std::shared_ptr< AMP::LinearAlgebra::Variable > var)
	Set the input variable.

void	setMatrix (std::shared_ptr< AMP::LinearAlgebra::Matrix > in_mat) override

virtual void	setOutputVariable (std::shared_ptr< AMP::LinearAlgebra::Variable > var)
	Set the output variable.

virtual void	setVariables (std::shared_ptr< AMP::LinearAlgebra::Variable > in, std::shared_ptr< AMP::LinearAlgebra::Variable > out)

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	~IdentityOperator ()
	Destructor.

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

std::shared_ptr< AMP::LinearAlgebra::Variable >	d_inputVariable

int	d_iObject_id

std::shared_ptr< AMP::LinearAlgebra::Matrix >	d_matrix

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

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

std::shared_ptr< AMP::LinearAlgebra::Variable >	d_outputVariable

Static Protected Attributes
static int	d_iInstance_id

Private Attributes
size_t	d_localSize = 0

Detailed Description

Class IdentityOperator is the identity operator A(u) = u

Definition at line 14 of file IdentityOperator.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

◆ IdentityOperator() [1/2]

AMP::Operator::IdentityOperator::IdentityOperator ( )

Constructor. This resets the matrix shared pointer.

◆ IdentityOperator() [2/2]

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

explicit

Constructor. This resets the matrix shared pointer.

Parameters

[in] params

◆ ~IdentityOperator()

virtual AMP::Operator::IdentityOperator::~IdentityOperator ( )

inlinevirtual

Destructor.

Definition at line 27 of file IdentityOperator.h.

Member Function Documentation

◆ apply() [1/2]

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

overridevirtual

The apply function for this operator, A, performs the following operation: r = A(u) Here, A(u) is simply a Matrix-Vector multiplication.

Parameters

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

Reimplemented from AMP::Operator::LinearOperator.

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

◆ createInputVector()

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

overridevirtual

Get a right vector ( For \(\mathbf{y}^T\mathbf{Ax}\), \(\mathbf{x}\) is a right vector )

Returns: A newly created right vector

Reimplemented from AMP::Operator::Operator.

◆ createOutputVector()

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

overridevirtual

Get a left vector ( For \(\mathbf{y}^T\mathbf{Ax}\), \(\mathbf{y}\) is a left vector )

Returns: A newly created left 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::LinearOperator::getInputVariable ( ) const

inlineoverridevirtualinherited

Return the input variable.

Reimplemented from AMP::Operator::Operator.

Reimplemented in AMP::Operator::MassLinearFEOperator, AMP::Operator::MemorySpaceMigrationLinearOperator, AMP::Operator::PetscMatrixShellOperator, AMP::Operator::TrilinosMatrixShellOperator, and AMP::TimeIntegrator::LinearTimeOperator.

Definition at line 63 of file LinearOperator.h.

References AMP::Operator::LinearOperator::d_inputVariable.

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

◆ getMatrix()

virtual std::shared_ptr< AMP::LinearAlgebra::Matrix > AMP::Operator::LinearOperator::getMatrix ( )

virtualinherited

Returns: The matrix representation of this linear operator.

Reimplemented in AMP::Operator::MemorySpaceMigrationLinearOperator.

◆ 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::LinearOperator::getOutputVariable ( ) const

inlineoverridevirtualinherited

Return the output variable.

Reimplemented from AMP::Operator::Operator.

Reimplemented in AMP::Operator::MassLinearFEOperator, AMP::Operator::MemorySpaceMigrationLinearOperator, AMP::Operator::PetscMatrixShellOperator, AMP::Operator::TrilinosMatrixShellOperator, and AMP::TimeIntegrator::LinearTimeOperator.

Definition at line 67 of file LinearOperator.h.

References AMP::Operator::LinearOperator::d_outputVariable.

◆ getParameters()

std::shared_ptr< OperatorParameters > AMP::Operator::IdentityOperator::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()

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.

◆ reset()

void AMP::Operator::IdentityOperator::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()

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.

◆ setInputVariable()

virtual void AMP::Operator::IdentityOperator::setInputVariable ( std::shared_ptr< AMP::LinearAlgebra::Variable > var )

inlinevirtual

Set the input variable.

Definition at line 60 of file IdentityOperator.h.

References AMP::Operator::LinearOperator::d_inputVariable.

◆ setMatrix()

void AMP::Operator::IdentityOperator::setMatrix ( std::shared_ptr< AMP::LinearAlgebra::Matrix > in_mat )

overridevirtual

Copies the shared pointer for the matrix representation of this linear operator.

Parameters

[in] in_mat The matrix representation of this linear operator.

Reimplemented from AMP::Operator::LinearOperator.

◆ setMemoryAndBackendParameters()

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

protectedinherited

◆ setOutputVariable()

virtual void AMP::Operator::IdentityOperator::setOutputVariable ( std::shared_ptr< AMP::LinearAlgebra::Variable > var )

inlinevirtual

Set the output variable.

Definition at line 66 of file IdentityOperator.h.

References AMP::Operator::LinearOperator::d_outputVariable.

◆ setVariables()

virtual void AMP::Operator::LinearOperator::setVariables	(	std::shared_ptr< AMP::LinearAlgebra::Variable >	in,
		std::shared_ptr< AMP::LinearAlgebra::Variable >	out
	)

inlinevirtualinherited

Definition at line 56 of file LinearOperator.h.

References AMP::Operator::LinearOperator::d_inputVariable, and AMP::Operator::LinearOperator::d_outputVariable.

Referenced by AMP::Solver::AMG::coarse_operator< Config >::coarse_operator().

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

inlineoverridevirtual

Return the name of the operator.

Implements AMP::Operator::Operator.

Definition at line 30 of file IdentityOperator.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_inputVariable

std::shared_ptr<AMP::LinearAlgebra::Variable> AMP::Operator::LinearOperator::d_inputVariable

protectedinherited

Definition at line 88 of file LinearOperator.h.

Referenced by AMP::Operator::LinearOperator::getInputVariable(), setInputVariable(), and AMP::Operator::LinearOperator::setVariables().

◆ d_iObject_id

int AMP::Operator::Operator::d_iObject_id

protectedinherited

Definition at line 189 of file Operator.h.

◆ d_localSize

size_t AMP::Operator::IdentityOperator::d_localSize = 0

private

Definition at line 83 of file IdentityOperator.h.

◆ d_matrix

std::shared_ptr<AMP::LinearAlgebra::Matrix> AMP::Operator::LinearOperator::d_matrix

protectedinherited

Definition at line 92 of file LinearOperator.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_outputVariable

std::shared_ptr<AMP::LinearAlgebra::Variable> AMP::Operator::LinearOperator::d_outputVariable

protectedinherited

Definition at line 90 of file LinearOperator.h.

Referenced by AMP::Operator::LinearOperator::getOutputVariable(), setOutputVariable(), and AMP::Operator::LinearOperator::setVariables().

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

src/operators/IdentityOperator.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Attributes

Detailed Description

Member Typedef Documentation

◆ shared_ptr

Constructor & Destructor Documentation

◆ IdentityOperator() [1/2]

◆ IdentityOperator() [2/2]

◆ ~IdentityOperator()

Member Function Documentation

◆ apply() [1/2]

◆ apply() [2/2]

◆ createInputVector()

◆ createOutputVector()

◆ getBackendFromInput()

◆ getInputVariable()

◆ getJacobianParameters()

◆ getMatrix()

◆ getMemoryLocation()

◆ getMesh() [1/2]

◆ getMesh() [2/2]

◆ getOutputVariable()

◆ getParameters()

◆ isValidVector()

◆ makeConsistent()

◆ reInitializeVector()

◆ reset()

◆ residual()

◆ selectInputVector()

◆ selectOutputVector()

◆ setDebugPrintInfoLevel()

◆ setInputVariable()

◆ setMatrix()

◆ setMemoryAndBackendParameters()

◆ setOutputVariable()

◆ setVariables()

◆ subsetInputVector() [1/2]

◆ subsetInputVector() [2/2]

◆ subsetOutputVector() [1/2]

◆ subsetOutputVector() [2/2]

◆ type()

Member Data Documentation

◆ d_backend

◆ d_iDebugPrintInfoLevel

◆ d_iInstance_id

◆ d_inputVariable

◆ d_iObject_id

◆ d_localSize

◆ d_matrix

◆ d_memory_location

◆ d_Mesh

◆ d_outputVariable