#include <RadiationDiffusionFDBDFWrappers.h>

Inheritance diagram for AMP::Operator::BDFRadDifOp:

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

Public Member Functions
void	apply (AMP::LinearAlgebra::Vector::const_shared_ptr u_in, AMP::LinearAlgebra::Vector::shared_ptr r) override
	Compute r <- u + gamma*L(u)

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

	BDFRadDifOp (std::shared_ptr< const AMP::Operator::OperatorParameters > params_)
	Constructor.

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)

bool	isValidVector (std::shared_ptr< const AMP::LinearAlgebra::Vector > ET) override
	Returns RadDifOp's isValidVector.

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.

void	setComponentScalings (std::shared_ptr< AMP::LinearAlgebra::Vector > s, std::shared_ptr< AMP::LinearAlgebra::Vector > f)
	Set multiphysics scalings.

virtual void	setDebugPrintInfoLevel (int level)

void	setGamma (AMP::Scalar gamma_)
	Set the scaled time-step size of the operator.

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
	Used to register this operator in a factory.

virtual	~BDFRadDifOp ()
	Destructor.

Public Attributes
double	d_gamma = -1.0
	Time-step size (up to scaling by BDF constants)

std::shared_ptr< RadDifOp >	d_RadDifOp = nullptr
	The underlying radiation diffusion spatial operator.

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

std::shared_ptr< AMP::Operator::OperatorParameters >	getJacobianParameters (AMP::LinearAlgebra::Vector::const_shared_ptr u_in) override
	Returns a parameter object that may be used to reset the associated RadDifPJacOp operator.

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::shared_ptr< AMP::LinearAlgebra::Vector >	d_pFunctionScaling

std::shared_ptr< AMP::LinearAlgebra::Vector >	d_pScratchSolVector

std::shared_ptr< AMP::LinearAlgebra::Vector >	d_pSolutionScaling
	Vectors for multiphysics scaling.

Static Protected Attributes
static int	d_iInstance_id

Detailed Description

The classes in this file either are (or are associated with) wrapping spatial radiation diffusion operators, i.e., RadiationDiffusionFD and its Jacobian, as backward Euler operators, i. e., multiplying them by some time-step size and adding an identity. These operators here are closely related to AMP::TimeIntegrator::TimeOperator -------------------------------------------------------------— *

------— Class wrapping a RadDifOp as a BDF operator -------— *

Implements the Operator u + gamma*L(u) where L is a RadDifOp. This operator arises from the BDF discretization of the ODEs u'(t) + L(u) = s(t). The incoming OperatorParameters are used to create operator L.

Definition at line 45 of file RadiationDiffusionFDBDFWrappers.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

◆ BDFRadDifOp()

AMP::Operator::BDFRadDifOp::BDFRadDifOp ( std::shared_ptr< const AMP::Operator::OperatorParameters > params_ )

Constructor.

◆ ~BDFRadDifOp()

virtual AMP::Operator::BDFRadDifOp::~BDFRadDifOp ( )

inlinevirtual

Destructor.

Definition at line 58 of file RadiationDiffusionFDBDFWrappers.h.

Member Function Documentation

◆ apply() [1/2]

void AMP::Operator::BDFRadDifOp::apply	(	AMP::LinearAlgebra::Vector::const_shared_ptr	u_in,
		AMP::LinearAlgebra::Vector::shared_ptr	r
	)

override

Compute r <- u + gamma*L(u)

◆ 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

◆ 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() [1/2]

std::shared_ptr< AMP::Operator::OperatorParameters > AMP::Operator::BDFRadDifOp::getJacobianParameters ( AMP::LinearAlgebra::Vector::const_shared_ptr u_in )

overrideprotected

Returns a parameter object that may be used to reset the associated RadDifPJacOp operator.

Parameters

[in] u_in The current nonlinear iterate.

Note that the base class's getParameters() get's redirected to this function.

◆ getJacobianParameters() [2/2]

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.

◆ isValidVector()

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

inlineoverridevirtual

Returns RadDifOp's isValidVector.

Reimplemented from AMP::Operator::Operator.

Definition at line 68 of file RadiationDiffusionFDBDFWrappers.h.

References d_RadDifOp.

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

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.

◆ setComponentScalings()

void AMP::Operator::BDFRadDifOp::setComponentScalings	(	std::shared_ptr< AMP::LinearAlgebra::Vector >	s,
		std::shared_ptr< AMP::LinearAlgebra::Vector >	f
	)

Set multiphysics scalings.

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

◆ setGamma()

void AMP::Operator::BDFRadDifOp::setGamma ( AMP::Scalar gamma_ )

Set the scaled time-step size of the 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::BDFRadDifOp::type ( ) const

inlineoverridevirtual

Used to register this operator in a factory.

Implements AMP::Operator::Operator.

Definition at line 65 of file RadiationDiffusionFDBDFWrappers.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_gamma

double AMP::Operator::BDFRadDifOp::d_gamma = -1.0

Time-step size (up to scaling by BDF constants)

Definition at line 50 of file RadiationDiffusionFDBDFWrappers.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_pFunctionScaling

std::shared_ptr<AMP::LinearAlgebra::Vector> AMP::Operator::BDFRadDifOp::d_pFunctionScaling

protected

Definition at line 85 of file RadiationDiffusionFDBDFWrappers.h.

◆ d_pScratchSolVector

std::shared_ptr<AMP::LinearAlgebra::Vector> AMP::Operator::BDFRadDifOp::d_pScratchSolVector

protected

Definition at line 86 of file RadiationDiffusionFDBDFWrappers.h.

◆ d_pSolutionScaling

std::shared_ptr<AMP::LinearAlgebra::Vector> AMP::Operator::BDFRadDifOp::d_pSolutionScaling

protected

Vectors for multiphysics scaling.

Definition at line 84 of file RadiationDiffusionFDBDFWrappers.h.

◆ d_RadDifOp

std::shared_ptr<RadDifOp> AMP::Operator::BDFRadDifOp::d_RadDifOp = nullptr

The underlying radiation diffusion spatial operator.

Definition at line 52 of file RadiationDiffusionFDBDFWrappers.h.

Referenced by isValidVector().

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

src/operators/radiationDiffusionFD/RadiationDiffusionFDBDFWrappers.h

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

------— Class wrapping a RadDifOp as a BDF operator -------— *

Member Typedef Documentation

◆ shared_ptr

Constructor & Destructor Documentation

◆ BDFRadDifOp()

◆ ~BDFRadDifOp()

Member Function Documentation

◆ apply() [1/2]

◆ apply() [2/2]

◆ createInputVector()

◆ createOutputVector()

◆ getBackendFromInput()

◆ getInputVariable()

◆ getJacobianParameters() [1/2]

◆ getJacobianParameters() [2/2]

◆ getMemoryLocation()

◆ getMesh() [1/2]

◆ getMesh() [2/2]

◆ getOutputVariable()

◆ getParameters()

◆ isValidVector()

◆ makeConsistent()

◆ reInitializeVector()

◆ reset()

◆ residual()

◆ selectInputVector()

◆ selectOutputVector()

◆ setComponentScalings()

◆ setDebugPrintInfoLevel()

◆ setGamma()

◆ setMemoryAndBackendParameters()

◆ subsetInputVector() [1/2]

◆ subsetInputVector() [2/2]

◆ subsetOutputVector() [1/2]

◆ subsetOutputVector() [2/2]

◆ type()

Member Data Documentation

◆ d_backend

◆ d_gamma

◆ d_iDebugPrintInfoLevel

◆ d_iInstance_id

◆ d_iObject_id

◆ d_memory_location

◆ d_Mesh

◆ d_pFunctionScaling

◆ d_pScratchSolVector

◆ d_pSolutionScaling

◆ d_RadDifOp