AMP::Operator::ColumnBoundaryOperator Class Reference

#include <ColumnBoundaryOperator.h>

Inheritance diagram for AMP::Operator::ColumnBoundaryOperator:

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

Public Member Functions
void	addRHScorrection (AMP::LinearAlgebra::Vector::shared_ptr) override
virtual void	append (std::shared_ptr< BoundaryOperator > op)
void	apply (AMP::LinearAlgebra::Vector::const_shared_ptr u, AMP::LinearAlgebra::Vector::shared_ptr r) override
virtual void	apply (std::shared_ptr< const AMP::LinearAlgebra::Vector > u, std::shared_ptr< AMP::LinearAlgebra::Vector > f)=0
	ColumnBoundaryOperator (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 )
std::shared_ptr< BoundaryOperator >	getBoundaryOperator (int i)
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.
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)
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)
void	modifyInitialSolutionVector (AMP::LinearAlgebra::Vector::shared_ptr) override
size_t	numberOfBoundaryOperators ()
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)
void	setRHScorrection (AMP::LinearAlgebra::Vector::shared_ptr) 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	~ColumnBoundaryOperator ()

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< BoundaryOperator > >	d_Operators

Static Protected Attributes
static int	d_iInstance_id

Detailed Description

A class for representing a composite boundary operator, F=(F1, F2, F3, .., Fk), where each of F1,.., Fk are boundary operators themselves. The user is expected to have created and initialized the operators F1,.., Fk. This class can be used to impose a mix of boundary conditions for a volume operator over the boundary

Definition at line 24 of file ColumnBoundaryOperator.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

ColumnBoundaryOperator()

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

explicit

~ColumnBoundaryOperator()

virtual AMP::Operator::ColumnBoundaryOperator::~ColumnBoundaryOperator ( )

inlinevirtual

Definition at line 30 of file ColumnBoundaryOperator.h.

Member Function Documentation

addRHScorrection()

void AMP::Operator::ColumnBoundaryOperator::addRHScorrection ( AMP::LinearAlgebra::Vector::shared_ptr  )

overridevirtual

Reimplemented from AMP::Operator::BoundaryOperator.

append()

virtual void AMP::Operator::ColumnBoundaryOperator::append ( std::shared_ptr< BoundaryOperator >  op )

virtual

Parameters

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

apply() [1/2]

void AMP::Operator::ColumnBoundaryOperator::apply ( AMP::LinearAlgebra::Vector::const_shared_ptr  u, AMP::LinearAlgebra::Vector::shared_ptr  r  )

override

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

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.

getBackendFromInput()

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

protectedinherited

getBoundaryOperator()

std::shared_ptr< BoundaryOperator > AMP::Operator::ColumnBoundaryOperator::getBoundaryOperator ( int  i )

inline

Definition at line 49 of file ColumnBoundaryOperator.h.

References d_Operators.

getInputVariable()

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

inlinevirtualinherited

Return the input variable.

Reimplemented in AMP::Operator::DirichletMatrixCorrection, AMP::Operator::NeumannVectorCorrection, AMP::Operator::ColumnOperator, AMP::Operator::ConstraintsEliminationOperator, AMP::Operator::ContactResidualCorrection, AMP::Operator::DiffusionNonlinearFEOperator, AMP::Operator::FickSoretNonlinearFEOperator, AMP::Operator::GradientOperator, AMP::Operator::MassLinearFEOperator, AMP::Operator::NodeToGaussPointOperator, AMP::Operator::VolumeIntegralOperator, AMP::Operator::LinearBVPOperator, AMP::Operator::LinearOperator, AMP::Operator::AsyncMapOperator, AMP::Operator::Map1Dto3D, AMP::Operator::Map3Dto1D, AMP::Operator::MapSurface, AMP::Operator::MechanicsNonlinearFEOperator, AMP::Operator::MemorySpaceMigrationLinearOperator, AMP::Operator::MemorySpaceMigrationOperator, AMP::Operator::MoveMeshOperator, AMP::Operator::FirstOperator, AMP::Operator::SecondOperator, AMP::Operator::NonlinearBVPOperator, AMP::Operator::PetscMatrixShellOperator, AMP::Operator::CoupledChannelToCladMapOperator, AMP::Operator::CoupledFlowFrapconOperator, AMP::Operator::FlowFrapconJacobian, AMP::Operator::FlowFrapconOperator, AMP::Operator::SubchannelFourEqNonlinearOperator, AMP::Operator::SubchannelToPointMap, AMP::Operator::SubchannelTwoEqNonlinearOperator, AMP::Operator::TrilinosMatrixShellOperator, AMP::Operator::VectorCopyOperator, and AMP::TimeIntegrator::LinearTimeOperator.

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.

Reimplemented in AMP::Operator::DirichletMatrixCorrection, AMP::Operator::NeumannVectorCorrection, AMP::Operator::ColumnOperator, AMP::Operator::ConstraintsEliminationOperator, AMP::Operator::ContactResidualCorrection, AMP::Operator::CoupledOperator, AMP::Operator::DiffusionNonlinearFEOperator, AMP::Operator::FickSoretNonlinearFEOperator, AMP::Operator::GradientOperator, AMP::Operator::MassLinearFEOperator, AMP::Operator::NodeToGaussPointOperator, AMP::Operator::VolumeIntegralOperator, AMP::Operator::LinearBVPOperator, AMP::Operator::LinearOperator, AMP::Operator::AsyncMapOperator, AMP::Operator::Map1Dto3D, AMP::Operator::Map3Dto1D, AMP::Operator::MapSurface, AMP::Operator::MechanicsNonlinearFEOperator, AMP::Operator::MemorySpaceMigrationLinearOperator, AMP::Operator::MemorySpaceMigrationOperator, AMP::Operator::NeutronicsRhs, AMP::Operator::FirstOperator, AMP::Operator::SecondOperator, AMP::Operator::NonlinearBVPOperator, AMP::Operator::PetscMatrixShellOperator, AMP::Operator::CoupledChannelToCladMapOperator, AMP::Operator::CoupledFlowFrapconOperator, AMP::Operator::FlowFrapconJacobian, AMP::Operator::FlowFrapconOperator, AMP::Operator::SubchannelFourEqNonlinearOperator, AMP::Operator::SubchannelToPointMap, AMP::Operator::SubchannelTwoEqNonlinearOperator, AMP::Operator::TrilinosMatrixShellOperator, AMP::Operator::VectorCopyOperator, AMP::TimeIntegrator::LinearTimeOperator, and AMP::TimeIntegrator::TimeOperator.

Definition at line 100 of file Operator.h.

getParameters() [1/2]

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

override

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

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.

modifyInitialSolutionVector()

void AMP::Operator::ColumnBoundaryOperator::modifyInitialSolutionVector ( AMP::LinearAlgebra::Vector::shared_ptr  )

overridevirtual

Reimplemented from AMP::Operator::BoundaryOperator.

numberOfBoundaryOperators()

size_t AMP::Operator::ColumnBoundaryOperator::numberOfBoundaryOperators ( )

inline

Definition at line 51 of file ColumnBoundaryOperator.h.

References d_Operators.

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::ColumnBoundaryOperator::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.

setMemoryAndBackendParameters()

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

protectedinherited

setRHScorrection()

void AMP::Operator::ColumnBoundaryOperator::setRHScorrection ( AMP::LinearAlgebra::Vector::shared_ptr  )

overridevirtual

Reimplemented from AMP::Operator::BoundaryOperator.

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

inlineoverridevirtual

Return the name of the operator.

Implements AMP::Operator::Operator.

Definition at line 32 of file ColumnBoundaryOperator.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<BoundaryOperator> > AMP::Operator::ColumnBoundaryOperator::d_Operators

protected

Definition at line 60 of file ColumnBoundaryOperator.h.

Referenced by getBoundaryOperator(), and numberOfBoundaryOperators().

---

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

• src/operators/boundary/ColumnBoundaryOperator.h