Advanced Multi-Physics (AMP)
On-Line Documentation
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
AMP::TimeIntegrator::LinearTimeOperator Class Referenceabstract

base class for operator class associated with ImplicitTimeIntegrator More...

#include <LinearTimeOperator.h>

Inheritance diagram for AMP::TimeIntegrator::LinearTimeOperator:
Inheritance graph
[legend]

Public Types

typedef std::shared_ptr< AMP::Operator::Operatorshared_ptr
 

Public Member Functions

virtual 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::VectorcreateInputVector () const override
 Get a input vector ( For \(\mathbf{A(x)}\), \(\mathbf{x}\) is a input vector )
 
std::shared_ptr< AMP::LinearAlgebra::VectorcreateOutputVector () const override
 Get an output vector ( For \(\mathbf{y=A(x)}\), \(\mathbf{y}\) is an output vector )
 
std::shared_ptr< AMP::LinearAlgebra::VariablegetInputVariable () const override
 Return the input variable.
 
std::shared_ptr< OperatorgetMassOperator (void)
 
virtual std::shared_ptr< AMP::LinearAlgebra::MatrixgetMatrix ()
 
AMP::Utilities::MemoryType getMemoryLocation () const
 
std::shared_ptr< AMP::Mesh::MeshgetMesh ()
 Return the mesh.
 
std::shared_ptr< const AMP::Mesh::MeshgetMesh () const
 Return the mesh.
 
std::shared_ptr< AMP::LinearAlgebra::VariablegetOutputVariable () const override
 
std::shared_ptr< AMP::Operator::OperatorParametersgetParameters (const std::string &type, AMP::LinearAlgebra::Vector::const_shared_ptr u, std::shared_ptr< AMP::Operator::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)
 
std::shared_ptr< OperatorgetRhsOperator (void)
 
virtual bool isValidVector (std::shared_ptr< const AMP::LinearAlgebra::Vector >)
 given a vector return whether it is valid or not
 
 LinearTimeOperator (std::shared_ptr< const AMP::Operator::OperatorParameters > params)
 
virtual void makeConsistent (std::shared_ptr< AMP::LinearAlgebra::Vector > vec)
 
void registerCurrentTime (double currentTime)
 
void registerMassOperator (std::shared_ptr< AMP::Operator::LinearOperator > op)
 
void registerRhsOperator (std::shared_ptr< AMP::Operator::LinearOperator > op)
 
virtual void reInitializeVector (std::shared_ptr< AMP::LinearAlgebra::Vector >)
 
void reset (std::shared_ptr< const AMP::Operator::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::VectorSelectorselectInputVector () const
 Return the selector for input vectors.
 
virtual std::shared_ptr< AMP::LinearAlgebra::VectorSelectorselectOutputVector () const
 Return the selector for output vectors.
 
virtual void setDebugPrintInfoLevel (int level)
 
void setDt (double dt)
 
virtual void setMatrix (std::shared_ptr< AMP::LinearAlgebra::Matrix > in_mat)
 
void setScalingFactor (double scalingFactor)
 
virtual void setVariables (std::shared_ptr< AMP::LinearAlgebra::Variable > in, std::shared_ptr< AMP::LinearAlgebra::Variable > out)
 
std::shared_ptr< AMP::LinearAlgebra::VectorsubsetInputVector (std::shared_ptr< AMP::LinearAlgebra::Vector > vec) const
 Subset input vector.
 
std::shared_ptr< const AMP::LinearAlgebra::VectorsubsetInputVector (std::shared_ptr< const AMP::LinearAlgebra::Vector > vec) const
 Subset input vector.
 
std::shared_ptr< AMP::LinearAlgebra::VectorsubsetOutputVector (std::shared_ptr< AMP::LinearAlgebra::Vector > vec) const
 Subset output vector.
 
std::shared_ptr< const AMP::LinearAlgebra::VectorsubsetOutputVector (std::shared_ptr< const AMP::LinearAlgebra::Vector > vec) const
 Subset output vector.
 
std::string type () const override
 Return the name of the operator.
 
virtual ~LinearTimeOperator ()
 

Protected Member Functions

void getBackendFromInput (std::shared_ptr< AMP::Database > db)
 
void getFromInput (std::shared_ptr< AMP::Database > db)
 
virtual std::shared_ptr< OperatorParameters > getJacobianParameters (std::shared_ptr< const AMP::LinearAlgebra::Vector >)
 
 LinearTimeOperator ()
 
void setMemoryAndBackendParameters (std::shared_ptr< AMP::Database > db)
 

Protected Attributes

AMP::Utilities::Backend d_backend = AMP::Utilities::Backend::Serial
 
bool d_bAlgebraicComponent
 
double d_beta
 
bool d_bModifyRhsOperatorMatrix
 
double d_current_time
 
double d_dCurrentDt
 
double d_dScalingFactor
 
int d_iDebugPrintInfoLevel = 0
 
std::shared_ptr< AMP::LinearAlgebra::Variabled_inputVariable
 
int d_iObject_id
 
std::shared_ptr< AMP::LinearAlgebra::Matrixd_matrix
 
AMP::Utilities::MemoryType d_memory_location = AMP::Utilities::MemoryType::none
 
std::shared_ptr< AMP::Mesh::Meshd_Mesh
 
std::shared_ptr< AMP::LinearAlgebra::Variabled_outputVariable
 
std::shared_ptr< AMP::Operator::LinearOperatord_pMassOperator
 
std::shared_ptr< AMP::Operator::LinearOperatord_pRhsOperator
 
std::shared_ptr< AMP::LinearAlgebra::Vectord_pScratchVector
 

Static Protected Attributes

static int d_iInstance_id
 

Detailed Description

base class for operator class associated with ImplicitTimeIntegrator

Class ImplicitLinearTimeOperator is a base class derived from Operator. It is the operator class associated with a ImplicitTimeIntegrator. The solver associated with the ImplicitTimeIntegrator will register this object.

See also
ImplicitTimeIntegrator
Operator
SolverStrategy

Definition at line 24 of file LinearTimeOperator.h.

Member Typedef Documentation

◆ shared_ptr

Definition at line 29 of file Operator.h.

Constructor & Destructor Documentation

◆ LinearTimeOperator() [1/2]

AMP::TimeIntegrator::LinearTimeOperator::LinearTimeOperator ( std::shared_ptr< const AMP::Operator::OperatorParameters params)
explicit

◆ ~LinearTimeOperator()

virtual AMP::TimeIntegrator::LinearTimeOperator::~LinearTimeOperator ( )
virtual

◆ LinearTimeOperator() [2/2]

AMP::TimeIntegrator::LinearTimeOperator::LinearTimeOperator ( )
protected

Member Function Documentation

◆ apply() [1/2]

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

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

Parameters
[in]uinput vector.
[out]fresidual/output vector.

Reimplemented in AMP::Operator::IdentityOperator, AMP::Operator::PetscMatrixShellOperator, AMP::Operator::TrilinosMatrixShellOperator, and AMP::Operator::BDFRadDifOpPJac.

◆ 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
ushared pointer to const input vector u
fshared 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::LinearOperator::createInputVector ( ) const
overridevirtualinherited

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

Returns
A newly created input vector

Reimplemented from AMP::Operator::Operator.

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

◆ createOutputVector()

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

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

Returns
A newly created output vector

Reimplemented from AMP::Operator::Operator.

Reimplemented in AMP::Operator::MemorySpaceMigrationLinearOperator.

◆ getBackendFromInput()

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

◆ getFromInput()

void AMP::TimeIntegrator::LinearTimeOperator::getFromInput ( std::shared_ptr< AMP::Database db)
protected

◆ getInputVariable()

std::shared_ptr< AMP::LinearAlgebra::Variable > AMP::TimeIntegrator::LinearTimeOperator::getInputVariable ( ) const
inlineoverridevirtual

Return the input variable.

Reimplemented from AMP::Operator::LinearOperator.

Definition at line 55 of file LinearTimeOperator.h.

References d_pRhsOperator.

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

◆ getMassOperator()

std::shared_ptr< Operator > AMP::TimeIntegrator::LinearTimeOperator::getMassOperator ( void  )
inline

Definition at line 47 of file LinearTimeOperator.h.

References d_pMassOperator.

◆ 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::TimeIntegrator::LinearTimeOperator::getOutputVariable ( ) const
inlineoverridevirtual

returns a Variable object corresponding to the rhs operator

Reimplemented from AMP::Operator::LinearOperator.

Definition at line 63 of file LinearTimeOperator.h.

References d_pRhsOperator.

◆ getParameters() [1/2]

std::shared_ptr< AMP::Operator::OperatorParameters > AMP::TimeIntegrator::LinearTimeOperator::getParameters ( const std::string &  type,
AMP::LinearAlgebra::Vector::const_shared_ptr  u,
std::shared_ptr< AMP::Operator::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
typestd:string specifying type of return operator parameters being requested. Currently the valid option is Jacobian
uconst pointer to current solution vector
paramspointer to additional parameters that might be required to construct the return parameters

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

◆ getRhsOperator()

std::shared_ptr< Operator > AMP::TimeIntegrator::LinearTimeOperator::getRhsOperator ( void  )
inline

Definition at line 46 of file LinearTimeOperator.h.

References d_pRhsOperator.

◆ isValidVector()

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

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

◆ registerCurrentTime()

void AMP::TimeIntegrator::LinearTimeOperator::registerCurrentTime ( double  currentTime)
inline

Definition at line 68 of file LinearTimeOperator.h.

References d_current_time.

◆ registerMassOperator()

void AMP::TimeIntegrator::LinearTimeOperator::registerMassOperator ( std::shared_ptr< AMP::Operator::LinearOperator op)
inline

Definition at line 41 of file LinearTimeOperator.h.

References d_pMassOperator.

◆ registerRhsOperator()

void AMP::TimeIntegrator::LinearTimeOperator::registerRhsOperator ( std::shared_ptr< AMP::Operator::LinearOperator op)
inline

Definition at line 37 of file LinearTimeOperator.h.

References d_pRhsOperator.

◆ 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::TimeIntegrator::LinearTimeOperator::reset ( std::shared_ptr< const AMP::Operator::OperatorParameters params)
overridevirtual

This function is useful for re-initializing an operator

Parameters
paramsparameter 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
fshared pointer to const vector rhs
ushared pointer to const vector u
rshared 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

◆ selectOutputVector()

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

◆ setDebugPrintInfoLevel()

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

Specify level of diagnostic information printed during iterations.

Parameters
levelzero 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.

◆ setDt()

void AMP::TimeIntegrator::LinearTimeOperator::setDt ( double  dt)
inline

Definition at line 49 of file LinearTimeOperator.h.

References d_dCurrentDt.

◆ setMatrix()

virtual void AMP::Operator::LinearOperator::setMatrix ( std::shared_ptr< AMP::LinearAlgebra::Matrix in_mat)
virtualinherited

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

Parameters
[in]in_matThe matrix representation of this linear operator.

Reimplemented in AMP::Operator::IdentityOperator.

Referenced by AMP::Solver::AMG::coarse_operator< Config >::coarse_operator(), and AMP::Operator::EpetraMatrixOperator::EpetraMatrixOperator().

◆ setMemoryAndBackendParameters()

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

◆ setScalingFactor()

void AMP::TimeIntegrator::LinearTimeOperator::setScalingFactor ( double  scalingFactor)
inline

Definition at line 52 of file LinearTimeOperator.h.

References d_dScalingFactor.

◆ setVariables()

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

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

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_bAlgebraicComponent

bool AMP::TimeIntegrator::LinearTimeOperator::d_bAlgebraicComponent
protected

set to true if this operator corresponds to an algebraic component

Definition at line 85 of file LinearTimeOperator.h.

◆ d_beta

double AMP::TimeIntegrator::LinearTimeOperator::d_beta
protected

Definition at line 97 of file LinearTimeOperator.h.

◆ d_bModifyRhsOperatorMatrix

bool AMP::TimeIntegrator::LinearTimeOperator::d_bModifyRhsOperatorMatrix
protected

Definition at line 80 of file LinearTimeOperator.h.

◆ d_current_time

double AMP::TimeIntegrator::LinearTimeOperator::d_current_time
protected

Definition at line 96 of file LinearTimeOperator.h.

Referenced by registerCurrentTime().

◆ d_dCurrentDt

double AMP::TimeIntegrator::LinearTimeOperator::d_dCurrentDt
protected

Definition at line 88 of file LinearTimeOperator.h.

Referenced by setDt().

◆ d_dScalingFactor

double AMP::TimeIntegrator::LinearTimeOperator::d_dScalingFactor
protected

Definition at line 87 of file LinearTimeOperator.h.

Referenced by setScalingFactor().

◆ 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

◆ d_iObject_id

int AMP::Operator::Operator::d_iObject_id
protectedinherited

Definition at line 189 of file Operator.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

◆ d_outputVariable

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

◆ d_pMassOperator

std::shared_ptr<AMP::Operator::LinearOperator> AMP::TimeIntegrator::LinearTimeOperator::d_pMassOperator
protected

Definition at line 92 of file LinearTimeOperator.h.

Referenced by getMassOperator(), and registerMassOperator().

◆ d_pRhsOperator

std::shared_ptr<AMP::Operator::LinearOperator> AMP::TimeIntegrator::LinearTimeOperator::d_pRhsOperator
protected

◆ d_pScratchVector

std::shared_ptr<AMP::LinearAlgebra::Vector> AMP::TimeIntegrator::LinearTimeOperator::d_pScratchVector
protected

Definition at line 94 of file LinearTimeOperator.h.


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



Advanced Multi-Physics (AMP)
Oak Ridge National Laboratory
Idaho National Laboratory
Los Alamos National Laboratory
This page automatically produced from the
source code by doxygen
Last updated: Tue Mar 10 2026 13:06:45.
Comments on this page