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

#include <CoupledFlowFrapconOperator.h>

Inheritance diagram for AMP::Operator::CoupledFlowFrapconOperator:
Inheritance graph
[legend]

Public Types

typedef std::shared_ptr< AMP::Operator::Operatorshared_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
 
virtual void apply (std::shared_ptr< const AMP::LinearAlgebra::Vector > u, std::shared_ptr< AMP::LinearAlgebra::Vector > f)=0
 
auto begin ()
 Return an iterator to the beginning of the operators.
 
 CoupledFlowFrapconOperator (std::shared_ptr< const OperatorParameters > params)
 
virtual std::shared_ptr< AMP::LinearAlgebra::VectorcreateInputVector () const
 Get a input vector ( For \(\mathbf{A(x)}\), \(\mathbf{x}\) is a input vector )
 
virtual std::shared_ptr< AMP::LinearAlgebra::VectorcreateOutputVector () 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::VariablegetInputVariable () const override
 Return the input variable.
 
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.
 
size_t getNumberOfOperators ()
 
std::shared_ptr< OperatorgetOperator (size_t i)
 
const autogetOperators ()
 
std::shared_ptr< AMP::LinearAlgebra::VariablegetOutputVariable () const override
 
std::shared_ptr< OperatorParametersgetParameters (const std::string &type, AMP::LinearAlgebra::Vector::const_shared_ptr u, std::shared_ptr< OperatorParameters > params=NULL) override
 
virtual std::shared_ptr< OperatorParametersgetParameters (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::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)
 
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 ~CoupledFlowFrapconOperator ()
 

Protected Member Functions

void getBackendFromInput (std::shared_ptr< AMP::Database > db)
 
virtual std::shared_ptr< OperatorParametersgetJacobianParameters (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::Meshd_Mesh
 
std::vector< std::shared_ptr< Operator > > d_operators
 

Static Protected Attributes

static int d_iInstance_id
 

Private Attributes

AMP::LinearAlgebra::Vector::shared_ptr d_flowInput
 
AMP::Operator::MapOperator::shared_ptr d_flowInternal1to3
 
AMP::Operator::MapOperator::shared_ptr d_flowInternal3to1
 
AMP::LinearAlgebra::Vector::shared_ptr d_flowOutput
 
AMP::LinearAlgebra::Vector::shared_ptr d_localCladVec
 
int d_numpoints
 
std::shared_ptr< AMP::LinearAlgebra::Variabled_SimpleVariable
 
std::vector< doubled_zPoints
 

Detailed Description

Definition at line 15 of file CoupledFlowFrapconOperator.h.

Member Typedef Documentation

◆ shared_ptr

Definition at line 29 of file Operator.h.

Constructor & Destructor Documentation

◆ CoupledFlowFrapconOperator()

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

◆ ~CoupledFlowFrapconOperator()

virtual AMP::Operator::CoupledFlowFrapconOperator::~CoupledFlowFrapconOperator ( )
inlinevirtual

Definition at line 54 of file CoupledFlowFrapconOperator.h.

Member Function Documentation

◆ append()

void AMP::Operator::CoupledFlowFrapconOperator::append ( std::shared_ptr< Operator op)
inlineoverridevirtual
Parameters
opshared pointer to an operator to append to the existing column of operators

Reimplemented from AMP::Operator::ColumnOperator.

Definition at line 39 of file CoupledFlowFrapconOperator.h.

References AMP_ASSERT, and AMP::Operator::ColumnOperator::d_operators.

◆ apply() [1/2]

void AMP::Operator::CoupledFlowFrapconOperator::apply ( AMP::LinearAlgebra::Vector::const_shared_ptr  u,
AMP::LinearAlgebra::Vector::shared_ptr  f 
)
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
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.

◆ 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

◆ 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::CoupledFlowFrapconOperator::getInputVariable ( ) const
inlineoverridevirtual

Return the input variable.

Reimplemented from AMP::Operator::ColumnOperator.

Definition at line 26 of file CoupledFlowFrapconOperator.h.

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

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

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

Definition at line 31 of file CoupledFlowFrapconOperator.h.

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

◆ getParameters() [1/2]

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

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

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

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

Parameters
paramsparameter object containing parameters to change

Reimplemented from AMP::Operator::ColumnOperator.

Definition at line 20 of file CoupledFlowFrapconOperator.h.

References AMP_ASSERT, and AMP::Operator::ColumnOperator::d_operators.

◆ residual() [1/2]

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

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

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

Return the name of the operator.

Reimplemented from AMP::Operator::ColumnOperator.

Definition at line 56 of file CoupledFlowFrapconOperator.h.

Referenced by getParameters().

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_flowInput

AMP::LinearAlgebra::Vector::shared_ptr AMP::Operator::CoupledFlowFrapconOperator::d_flowInput
private

Definition at line 65 of file CoupledFlowFrapconOperator.h.

◆ d_flowInternal1to3

AMP::Operator::MapOperator::shared_ptr AMP::Operator::CoupledFlowFrapconOperator::d_flowInternal1to3
private

Definition at line 70 of file CoupledFlowFrapconOperator.h.

◆ d_flowInternal3to1

AMP::Operator::MapOperator::shared_ptr AMP::Operator::CoupledFlowFrapconOperator::d_flowInternal3to1
private

Definition at line 69 of file CoupledFlowFrapconOperator.h.

◆ d_flowOutput

AMP::LinearAlgebra::Vector::shared_ptr AMP::Operator::CoupledFlowFrapconOperator::d_flowOutput
private

Definition at line 66 of file CoupledFlowFrapconOperator.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_localCladVec

AMP::LinearAlgebra::Vector::shared_ptr AMP::Operator::CoupledFlowFrapconOperator::d_localCladVec
private

Definition at line 67 of file CoupledFlowFrapconOperator.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_numpoints

int AMP::Operator::CoupledFlowFrapconOperator::d_numpoints
private

Number of points in z direction

Definition at line 62 of file CoupledFlowFrapconOperator.h.

◆ d_operators

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

◆ d_SimpleVariable

std::shared_ptr<AMP::LinearAlgebra::Variable> AMP::Operator::CoupledFlowFrapconOperator::d_SimpleVariable
private

Simple Input Variable

Definition at line 60 of file CoupledFlowFrapconOperator.h.

◆ d_zPoints

std::vector<double> AMP::Operator::CoupledFlowFrapconOperator::d_zPoints
private

vector to hold z locations

Definition at line 64 of file CoupledFlowFrapconOperator.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:44.
Comments on this page