#include <SubchannelFourEqNonlinearOperator.h>

Inheritance diagram for AMP::Operator::SubchannelFourEqNonlinearOperator:

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

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

Public Member Functions
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

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 )

void	fillSubchannelGrid (std::shared_ptr< AMP::Mesh::Mesh >)

void	getAxialFaces (const AMP::Mesh::MeshElement &, ElementPtr &, ElementPtr &)

std::map< AMP::Mesh::Point, double >	getGapWidths (std::shared_ptr< AMP::Mesh::Mesh >, const std::vector< double > &, const std::vector< double > &, const std::vector< double > &)
	Makes map of gap widths to their xy positions.

double	getInletTemperature ()
	Get the Inlet Temperature [K].

std::shared_ptr< AMP::LinearAlgebra::Variable >	getInputVariable () const override
	Return the input variable.

void	getLateralFaces (std::shared_ptr< AMP::Mesh::Mesh >, std::map< AMP::Mesh::Point, ElementPtr > &, std::map< AMP::Mesh::Point, ElementPtr > &)
	Makes map of lateral gaps to their centroids.

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.

double	getOutletPressure ()
	Get the Outlet Pressure [Pa].

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.

int	getSubchannelIndex (double x, double y)

std::shared_ptr< SubchannelPhysicsModel >	getSubchannelPhysicsModel ()
	Get the element physics model.

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)

std::shared_ptr< AMP::LinearAlgebra::VectorSelector >	selectInputVector () const override
	Return the selector for input vectors.

std::shared_ptr< AMP::LinearAlgebra::VectorSelector >	selectOutputVector () const override
	Return the selector for output vectors.

virtual void	setDebugPrintInfoLevel (int level)

void	setVector (AMP::LinearAlgebra::Vector::shared_ptr frozenVec)

	SubchannelFourEqNonlinearOperator (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	~SubchannelFourEqNonlinearOperator ()
	Destructor.

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

std::shared_ptr< OperatorParameters >	getJacobianParameters (AMP::LinearAlgebra::Vector::const_shared_ptr u) override
	Gets parameters from nonlinear operator for use in linear 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< const SubchannelOperatorParameters >	d_params

std::shared_ptr< SubchannelPhysicsModel >	d_subchannelPhysicsModel

Static Protected Attributes
static int	d_iInstance_id

Private Member Functions
double	DynamicViscosity (double, double)

double	Enthalpy (double, double)

ElementPtr	getAxiallyAdjacentLateralFace (const AMP::Mesh::MeshElement *, const AMP::Mesh::MeshElement &, const std::map< AMP::Mesh::Point, ElementPtr > &)

double	Temperature (double, double)

double	ThermalConductivity (double, double)

double	Volume (double, double)

Private Attributes
std::vector< double >	d_channelArea

std::vector< double >	d_channelDiam

std::vector< double >	d_channelMass

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

bool	d_forceNoConduction

bool	d_forceNoFriction

bool	d_forceNoHeatSource

bool	d_forceNoTurbulence

double	d_friction

std::string	d_frictionModel

double	d_gamma

std::string	d_heatShape

bool	d_initialized

std::shared_ptr< AMP::LinearAlgebra::Variable >	d_inpVariable

double	d_KG

std::vector< double >	d_lossGrid

double	d_mass

size_t	d_NGrid

size_t	d_numSubchannels

std::shared_ptr< AMP::LinearAlgebra::Variable >	d_outVariable

std::vector< bool >	d_ownSubChannel

double	d_Pout

double	d_prandtl

double	d_Q

std::vector< double >	d_QFraction

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

double	d_turbulenceCoef

double	d_win

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

Nonlinear 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 16 of file SubchannelFourEqNonlinearOperator.h.

Member Typedef Documentation

◆ ElementPtr

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

Definition at line 19 of file SubchannelFourEqNonlinearOperator.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

◆ SubchannelFourEqNonlinearOperator()

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

explicit

Constructor.

◆ ~SubchannelFourEqNonlinearOperator()

virtual AMP::Operator::SubchannelFourEqNonlinearOperator::~SubchannelFourEqNonlinearOperator ( )

inlinevirtual

Destructor.

Definition at line 25 of file SubchannelFourEqNonlinearOperator.h.

Member Function Documentation

◆ apply() [1/2]

void AMP::Operator::SubchannelFourEqNonlinearOperator::apply	(	AMP::LinearAlgebra::Vector::const_shared_ptr	u,
		AMP::LinearAlgebra::Vector::shared_ptr	f
	)

override

For this operator we have an in-place apply.

Parameters

[in]	u	input vector.
[out]	f	output vector.

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

◆ DynamicViscosity()

double AMP::Operator::SubchannelFourEqNonlinearOperator::DynamicViscosity	(	double	,
		double
	)

private

◆ Enthalpy()

double AMP::Operator::SubchannelFourEqNonlinearOperator::Enthalpy	(	double	,
		double
	)

private

◆ fillSubchannelGrid()

void AMP::Operator::SubchannelFourEqNonlinearOperator::fillSubchannelGrid ( std::shared_ptr< AMP::Mesh::Mesh > )

◆ getAxialFaces()

void AMP::Operator::SubchannelFourEqNonlinearOperator::getAxialFaces	(	const AMP::Mesh::MeshElement &	,
		ElementPtr &	,
		ElementPtr &
	)

◆ getAxiallyAdjacentLateralFace()

ElementPtr AMP::Operator::SubchannelFourEqNonlinearOperator::getAxiallyAdjacentLateralFace	(	const AMP::Mesh::MeshElement *	,
		const AMP::Mesh::MeshElement &	,
		const std::map< AMP::Mesh::Point, ElementPtr > &
	)

private

◆ getBackendFromInput()

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

protectedinherited

◆ getGapWidths()

std::map< AMP::Mesh::Point, double > AMP::Operator::SubchannelFourEqNonlinearOperator::getGapWidths	(	std::shared_ptr< AMP::Mesh::Mesh >	,
		const std::vector< double > &	,
		const std::vector< double > &	,
		const std::vector< double > &
	)

Makes map of gap widths to their xy positions.

◆ getInletTemperature()

double AMP::Operator::SubchannelFourEqNonlinearOperator::getInletTemperature ( )

inline

Get the Inlet Temperature [K].

Definition at line 66 of file SubchannelFourEqNonlinearOperator.h.

References d_Tin.

◆ getInputVariable()

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

inlineoverridevirtual

Return the input variable.

Reimplemented from AMP::Operator::Operator.

Definition at line 40 of file SubchannelFourEqNonlinearOperator.h.

References d_inpVariable.

◆ getJacobianParameters() [1/2]

std::shared_ptr< OperatorParameters > AMP::Operator::SubchannelFourEqNonlinearOperator::getJacobianParameters ( AMP::LinearAlgebra::Vector::const_shared_ptr u )

overrideprotected

Gets parameters from nonlinear operator for use in linear operator.

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

◆ getLateralFaces()

void AMP::Operator::SubchannelFourEqNonlinearOperator::getLateralFaces	(	std::shared_ptr< AMP::Mesh::Mesh >	,
		std::map< AMP::Mesh::Point, ElementPtr > &	,
		std::map< AMP::Mesh::Point, ElementPtr > &
	)

Makes map of lateral gaps to their centroids.

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

◆ getOutletPressure()

double AMP::Operator::SubchannelFourEqNonlinearOperator::getOutletPressure ( )

inline

Get the Outlet Pressure [Pa].

Definition at line 69 of file SubchannelFourEqNonlinearOperator.h.

References d_Pout.

◆ getOutputVariable()

std::shared_ptr< AMP::LinearAlgebra::Variable > AMP::Operator::SubchannelFourEqNonlinearOperator::getOutputVariable ( ) const

inlineoverridevirtual

Return the output variable.

Reimplemented from AMP::Operator::Operator.

Definition at line 45 of file SubchannelFourEqNonlinearOperator.h.

References d_outVariable.

◆ 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::SubchannelFourEqNonlinearOperator::getParams ( )

inline

Get the current operator parameters.

Definition at line 72 of file SubchannelFourEqNonlinearOperator.h.

References d_params.

◆ getSubchannelIndex()

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

◆ getSubchannelPhysicsModel()

std::shared_ptr< SubchannelPhysicsModel > AMP::Operator::SubchannelFourEqNonlinearOperator::getSubchannelPhysicsModel ( )

inline

Get the element physics model.

Definition at line 60 of file SubchannelFourEqNonlinearOperator.h.

References d_subchannelPhysicsModel.

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

std::shared_ptr< AMP::LinearAlgebra::VectorSelector > AMP::Operator::SubchannelFourEqNonlinearOperator::selectInputVector ( ) const

overridevirtual

Return the selector for input vectors.

Reimplemented from AMP::Operator::Operator.

◆ selectOutputVector()

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

overridevirtual

Return the selector for output vectors.

Reimplemented from AMP::Operator::Operator.

◆ 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

◆ setVector()

void AMP::Operator::SubchannelFourEqNonlinearOperator::setVector ( AMP::LinearAlgebra::Vector::shared_ptr frozenVec )

inline

Definition at line 54 of file SubchannelFourEqNonlinearOperator.h.

References d_cladTemperature.

◆ 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