#include <SubchannelTwoEqLinearOperator.h>

Inheritance diagram for AMP::Operator::SubchannelTwoEqLinearOperator:

[legend]

Public Types
typedef std::unique_ptr< AMP::Mesh::MeshElement >	ElementPtr

typedef std::shared_ptr< AMP::Operator::Operator >	shared_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::Vector >	createInputVector () const override
	Get a input vector ( For \(\mathbf{A(x)}\), \(\mathbf{x}\) is a input vector )

std::shared_ptr< AMP::LinearAlgebra::Vector >	createOutputVector () const override
	Get an output vector ( For \(\mathbf{y=A(x)}\), \(\mathbf{y}\) is an output 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.

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

auto	getParams ()
	Get the current operator parameters.

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)

void	setFrozenVector (AMP::LinearAlgebra::Vector::shared_ptr frozenVec)
	Sets frozen vector.

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

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

	SubchannelTwoEqLinearOperator (std::shared_ptr< const OperatorParameters > params)
	Constructor.

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

AMP::LinearAlgebra::Vector::shared_ptr	d_frozenVec

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

std::shared_ptr< const SubchannelOperatorParameters >	d_params

std::shared_ptr< SubchannelPhysicsModel >	d_subchannelPhysicsModel

Static Protected Attributes
static int	d_iInstance_id

Private Member Functions
double	dfdh_lower (double h_minus, double p_minus, double h_plus, double p_plus, double mass, double A, double D)

double	dfdh_upper (double h_minus, double p_minus, double h_plus, double p_plus, double mass, double A, double D)

double	dfdp_lower (double h_minus, double p_minus, double h_plus, double p_plus, double mass, double A, double D)

double	dfdp_upper (double h_minus, double p_minus, double h_plus, double p_plus, double mass, double A, double D)

double	dhdp (double, double)

double	dvdh (double, double)

double	dvdp (double, double)

double	friction (double h_minus, double p_minus, double h_plus, double p_plus, double mass, double A, double D)

int	getSubchannelIndex (double x, double y)

Private Attributes
std::vector< double >	d_channelArea

std::vector< double >	d_channelDiam

std::vector< double >	d_channelMass

double	d_friction

std::string	d_frictionModel

double	d_gamma

std::string	d_heatShape

bool	d_initialized

std::vector< double >	d_lossGrid

const double	d_machinePrecision

double	d_mass

size_t	d_NGrid

size_t	d_numSubchannels

std::vector< bool >	d_ownSubChannel

double	d_Pout

double	d_prandtl

double	d_Q

double	d_reynolds

std::vector< double >	d_rodDiameter

std::vector< double >	d_rodFraction

double	d_roughness

std::string	d_source

std::vector< std::vector< ElementPtr > >	d_subchannelElem

std::vector< std::vector< ElementPtr > >	d_subchannelFace

double	d_theta

double	d_Tin

std::vector< double >	d_x

std::vector< double >	d_y

std::vector< double >	d_z

std::vector< double >	d_zMaxGrid

std::vector< double >	d_zMinGrid

Detailed Description

Linear operator class for the 2-equation {enthalpy, pressure} formulation of the subchannel equations: see /AMPFuel-Docs/technicalInfo/flow/SubchannelFlow.pdf for details

Definition at line 18 of file SubchannelTwoEqLinearOperator.h.

Member Typedef Documentation

◆ ElementPtr

typedef std::unique_ptr<AMP::Mesh::MeshElement> AMP::Operator::SubchannelTwoEqLinearOperator::ElementPtr

Definition at line 21 of file SubchannelTwoEqLinearOperator.h.

◆ 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

◆ SubchannelTwoEqLinearOperator()

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

explicit

Constructor.

◆ ~SubchannelTwoEqLinearOperator()

virtual AMP::Operator::SubchannelTwoEqLinearOperator::~SubchannelTwoEqLinearOperator ( )

inlinevirtual

Destructor.

Definition at line 27 of file SubchannelTwoEqLinearOperator.h.

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]	u	input vector.
[out]	f	residual/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

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

◆ dfdh_lower()

double AMP::Operator::SubchannelTwoEqLinearOperator::dfdh_lower	(	double	h_minus,
		double	p_minus,
		double	h_plus,
		double	p_plus,
		double	mass,
		double	A,
		double	D
	)

private

◆ dfdh_upper()

double AMP::Operator::SubchannelTwoEqLinearOperator::dfdh_upper	(	double	h_minus,
		double	p_minus,
		double	h_plus,
		double	p_plus,
		double	mass,
		double	A,
		double	D
	)

private

◆ dfdp_lower()

double AMP::Operator::SubchannelTwoEqLinearOperator::dfdp_lower	(	double	h_minus,
		double	p_minus,
		double	h_plus,
		double	p_plus,
		double	mass,
		double	A,
		double	D
	)

private

◆ dfdp_upper()

double AMP::Operator::SubchannelTwoEqLinearOperator::dfdp_upper	(	double	h_minus,
		double	p_minus,
		double	h_plus,
		double	p_plus,
		double	mass,
		double	A,
		double	D
	)

private

◆ dhdp()

double AMP::Operator::SubchannelTwoEqLinearOperator::dhdp	(	double	,
		double
	)

private

◆ dvdh()

double AMP::Operator::SubchannelTwoEqLinearOperator::dvdh	(	double	,
		double
	)

private

◆ dvdp()

double AMP::Operator::SubchannelTwoEqLinearOperator::dvdp	(	double	,
		double
	)

private

◆ friction()

double AMP::Operator::SubchannelTwoEqLinearOperator::friction	(	double	h_minus,
		double	p_minus,
		double	h_plus,
		double	p_plus,
		double	mass,
		double	A,
		double	D
	)

private

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

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.

◆ getParams()

auto AMP::Operator::SubchannelTwoEqLinearOperator::getParams ( )

inline

Get the current operator parameters.

Definition at line 41 of file SubchannelTwoEqLinearOperator.h.

References d_params.

◆ getSubchannelIndex()

int AMP::Operator::SubchannelTwoEqLinearOperator::getSubchannelIndex	(	double	x,
		double	y
	)

private

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

◆ setFrozenVector()

void AMP::Operator::SubchannelTwoEqLinearOperator::setFrozenVector ( AMP::LinearAlgebra::Vector::shared_ptr frozenVec )

inline

Sets frozen vector.

Definition at line 35 of file SubchannelTwoEqLinearOperator.h.

References d_frozenVec.

◆ 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_mat The 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

◆ 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