Abstract base class for computing and caching internal or boundary fluxes for 1D conservation law systems. More...

#include <NumericalFlux1D.h>

Inheritance diagram for NumericalFlux1D:

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	NumericalFlux1D (const InputParameters &parameters)

virtual void	execute () override

virtual void	initialize () override

virtual void	finalize () override

virtual void	threadJoin (const UserObject &) override

virtual const std::vector< ADReal > &	getFlux (const unsigned int iside, const dof_id_type ielem, bool res_side_is_left, const std::vector< ADReal > &UL_1d, const std::vector< ADReal > &UR_1d, Real nLR_dot_d) const
	Gets the 1D flux vector for an element/side combination. More...

virtual const std::vector< ADReal > &	getFlux3D (const unsigned int iside, const dof_id_type ielem, const std::vector< ADReal > &UL_3d, const std::vector< ADReal > &UR_3d, const RealVectorValue &nLR, const RealVectorValue &t1, const RealVectorValue &t2) const
	Gets the 3D flux vector for an element/side combination on the left side. More...

virtual void	calcFlux (const std::vector< ADReal > &UL_3d, const std::vector< ADReal > &UR_3d, const RealVectorValue &nLR, const RealVectorValue &t1, const RealVectorValue &t2, std::vector< ADReal > &FL, std::vector< ADReal > &FR) const =0
	Calculates the 3D flux vectors given "left" and "right" states. More...

unsigned int	getLastRegionIndex () const
	Returns the index of the region last entered. More...

virtual unsigned int	getNumberOfRegions () const =0
	Returns the total possible number of regions. More...

virtual void	subdomainSetup () override

bool	needThreadedCopy () const override final

SubProblem &	getSubProblem () const

bool	shouldDuplicateInitialExecution () const

virtual Real	spatialValue (const Point &) const

virtual const std::vector< Point >	spatialPoints () const

void	gatherSum (T &value)

void	gatherMax (T &value)

void	gatherMin (T &value)

void	gatherProxyValueMax (T1 &proxy, T2 &value)

void	gatherProxyValueMin (T1 &proxy, T2 &value)

void	setPrimaryThreadCopy (UserObject *primary)

UserObject *	primaryThreadCopy ()

std::set< UserObjectName >	getDependObjects () const

const std::set< std::string > &	getRequestedItems () override

const std::set< std::string > &	getSuppliedItems () override

unsigned int	systemNumber () const

virtual bool	enabled () const

std::shared_ptr< MooseObject >	getSharedPtr ()

std::shared_ptr< const MooseObject >	getSharedPtr () const

MooseApp &	getMooseApp () const

const std::string &	type () const

virtual const std::string &	name () const

std::string	typeAndName () const

std::string	errorPrefix (const std::string &error_type) const

void	callMooseError (std::string msg, const bool with_prefix) const

MooseObjectParameterName	uniqueParameterName (const std::string &parameter_name) const

const InputParameters &	parameters () const

MooseObjectName	uniqueName () const

const T &	getParam (const std::string &name) const

std::vector< std::pair< T1, T2 > >	getParam (const std::string &param1, const std::string &param2) const

const T *	queryParam (const std::string &name) const

const T &	getRenamedParam (const std::string &old_name, const std::string &new_name) const

T	getCheckedPointerParam (const std::string &name, const std::string &error_string="") const

bool	isParamValid (const std::string &name) const

bool	isParamSetByUser (const std::string &nm) const

void	paramError (const std::string &param, Args... args) const

void	paramWarning (const std::string &param, Args... args) const

void	paramInfo (const std::string &param, Args... args) const

void	connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const

void	mooseError (Args &&... args) const

void	mooseErrorNonPrefixed (Args &&... args) const

void	mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const

void	mooseWarning (Args &&... args) const

void	mooseWarningNonPrefixed (Args &&... args) const

void	mooseDeprecated (Args &&... args) const

void	mooseInfo (Args &&... args) const

std::string	getDataFileName (const std::string &param) const

std::string	getDataFileNameByName (const std::string &relative_path) const

std::string	getDataFilePath (const std::string &relative_path) const

virtual void	initialSetup ()

virtual void	timestepSetup ()

virtual void	jacobianSetup ()

virtual void	residualSetup ()

virtual void	customSetup (const ExecFlagType &)

const ExecFlagEnum &	getExecuteOnEnum () const

UserObjectName	getUserObjectName (const std::string &param_name) const

const T &	getUserObject (const std::string &param_name, bool is_dependency=true) const

const T &	getUserObjectByName (const UserObjectName &object_name, bool is_dependency=true) const

const UserObject &	getUserObjectBase (const std::string &param_name, bool is_dependency=true) const

const UserObject &	getUserObjectBaseByName (const UserObjectName &object_name, bool is_dependency=true) const

const std::vector< MooseVariableScalar *> &	getCoupledMooseScalarVars ()

const std::set< TagID > &	getScalarVariableCoupleableVectorTags () const

const std::set< TagID > &	getScalarVariableCoupleableMatrixTags () const

const GenericMaterialProperty< T, is_ad > &	getGenericMaterialProperty (const std::string &name, MaterialData &material_data, const unsigned int state=0)

const GenericMaterialProperty< T, is_ad > &	getGenericMaterialProperty (const std::string &name, const unsigned int state=0)

const GenericMaterialProperty< T, is_ad > &	getGenericMaterialProperty (const std::string &name, const unsigned int state=0)

const MaterialProperty< T > &	getMaterialProperty (const std::string &name, MaterialData &material_data, const unsigned int state=0)

const MaterialProperty< T > &	getMaterialProperty (const std::string &name, const unsigned int state=0)

const MaterialProperty< T > &	getMaterialProperty (const std::string &name, const unsigned int state=0)

const ADMaterialProperty< T > &	getADMaterialProperty (const std::string &name, MaterialData &material_data)

const ADMaterialProperty< T > &	getADMaterialProperty (const std::string &name)

const ADMaterialProperty< T > &	getADMaterialProperty (const std::string &name)

const MaterialProperty< T > &	getMaterialPropertyOld (const std::string &name, MaterialData &material_data)

const MaterialProperty< T > &	getMaterialPropertyOld (const std::string &name)

const MaterialProperty< T > &	getMaterialPropertyOld (const std::string &name)

const MaterialProperty< T > &	getMaterialPropertyOlder (const std::string &name, MaterialData &material_data)

const MaterialProperty< T > &	getMaterialPropertyOlder (const std::string &name)

const MaterialProperty< T > &	getMaterialPropertyOlder (const std::string &name)

const GenericMaterialProperty< T, is_ad > &	getGenericMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data, const unsigned int state)

const GenericMaterialProperty< T, is_ad > &	getGenericMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)

const GenericMaterialProperty< T, is_ad > &	getGenericMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)

const MaterialProperty< T > &	getMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data, const unsigned int state=0)

const MaterialProperty< T > &	getMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)

const MaterialProperty< T > &	getMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)

const ADMaterialProperty< T > &	getADMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data)

const ADMaterialProperty< T > &	getADMaterialPropertyByName (const MaterialPropertyName &name)

const ADMaterialProperty< T > &	getADMaterialPropertyByName (const MaterialPropertyName &name)

const MaterialProperty< T > &	getMaterialPropertyOldByName (const MaterialPropertyName &name, MaterialData &material_data)

const MaterialProperty< T > &	getMaterialPropertyOldByName (const MaterialPropertyName &name)

const MaterialProperty< T > &	getMaterialPropertyOldByName (const MaterialPropertyName &name)

const MaterialProperty< T > &	getMaterialPropertyOlderByName (const MaterialPropertyName &name, MaterialData &material_data)

const MaterialProperty< T > &	getMaterialPropertyOlderByName (const MaterialPropertyName &name)

const MaterialProperty< T > &	getMaterialPropertyOlderByName (const MaterialPropertyName &name)

std::pair< const MaterialProperty< T > *, std::set< SubdomainID > >	getBlockMaterialProperty (const MaterialPropertyName &name)

const GenericMaterialProperty< T, is_ad > &	getGenericZeroMaterialProperty (const std::string &name)

const GenericMaterialProperty< T, is_ad > &	getGenericZeroMaterialProperty ()

const GenericMaterialProperty< T, is_ad > &	getGenericZeroMaterialPropertyByName (const std::string &prop_name)

const MaterialProperty< T > &	getZeroMaterialProperty (Ts... args)

std::set< SubdomainID >	getMaterialPropertyBlocks (const std::string &name)

std::vector< SubdomainName >	getMaterialPropertyBlockNames (const std::string &name)

std::set< BoundaryID >	getMaterialPropertyBoundaryIDs (const std::string &name)

std::vector< BoundaryName >	getMaterialPropertyBoundaryNames (const std::string &name)

void	checkBlockAndBoundaryCompatibility (std::shared_ptr< MaterialBase > discrete)

std::unordered_map< SubdomainID, std::vector< MaterialBase *> >	buildRequiredMaterials (bool allow_stateful=true)

void	statefulPropertiesAllowed (bool)

bool	getMaterialPropertyCalled () const

virtual const std::unordered_set< unsigned int > &	getMatPropDependencies () const

virtual void	resolveOptionalProperties ()

const GenericMaterialProperty< T, is_ad > &	getPossiblyConstantGenericMaterialPropertyByName (const MaterialPropertyName &prop_name, MaterialData &material_data, const unsigned int state)

bool	isImplicit ()

Moose::StateArg	determineState () const

bool	hasUserObject (const std::string &param_name) const

bool	hasUserObject (const std::string &param_name) const

bool	hasUserObject (const std::string &param_name) const

bool	hasUserObject (const std::string &param_name) const

bool	hasUserObjectByName (const UserObjectName &object_name) const

bool	hasUserObjectByName (const UserObjectName &object_name) const

bool	hasUserObjectByName (const UserObjectName &object_name) const

bool	hasUserObjectByName (const UserObjectName &object_name) const

const GenericOptionalMaterialProperty< T, is_ad > &	getGenericOptionalMaterialProperty (const std::string &name, const unsigned int state=0)

const GenericOptionalMaterialProperty< T, is_ad > &	getGenericOptionalMaterialProperty (const std::string &name, const unsigned int state=0)

const OptionalMaterialProperty< T > &	getOptionalMaterialProperty (const std::string &name, const unsigned int state=0)

const OptionalMaterialProperty< T > &	getOptionalMaterialProperty (const std::string &name, const unsigned int state=0)

const OptionalADMaterialProperty< T > &	getOptionalADMaterialProperty (const std::string &name)

const OptionalADMaterialProperty< T > &	getOptionalADMaterialProperty (const std::string &name)

const OptionalMaterialProperty< T > &	getOptionalMaterialPropertyOld (const std::string &name)

const OptionalMaterialProperty< T > &	getOptionalMaterialPropertyOld (const std::string &name)

const OptionalMaterialProperty< T > &	getOptionalMaterialPropertyOlder (const std::string &name)

const OptionalMaterialProperty< T > &	getOptionalMaterialPropertyOlder (const std::string &name)

MaterialBase &	getMaterial (const std::string &name)

MaterialBase &	getMaterial (const std::string &name)

MaterialBase &	getMaterialByName (const std::string &name, bool no_warn=false)

MaterialBase &	getMaterialByName (const std::string &name, bool no_warn=false)

bool	hasMaterialProperty (const std::string &name)

bool	hasMaterialProperty (const std::string &name)

bool	hasMaterialPropertyByName (const std::string &name)

bool	hasMaterialPropertyByName (const std::string &name)

bool	hasADMaterialProperty (const std::string &name)

bool	hasADMaterialProperty (const std::string &name)

bool	hasADMaterialPropertyByName (const std::string &name)

bool	hasADMaterialPropertyByName (const std::string &name)

bool	hasGenericMaterialProperty (const std::string &name)

bool	hasGenericMaterialProperty (const std::string &name)

bool	hasGenericMaterialPropertyByName (const std::string &name)

bool	hasGenericMaterialPropertyByName (const std::string &name)

const Function &	getFunction (const std::string &name) const

const Function &	getFunctionByName (const FunctionName &name) const

bool	hasFunction (const std::string &param_name) const

bool	hasFunctionByName (const FunctionName &name) const

bool	isDefaultPostprocessorValue (const std::string &param_name, const unsigned int index=0) const

bool	hasPostprocessor (const std::string &param_name, const unsigned int index=0) const

bool	hasPostprocessorByName (const PostprocessorName &name) const

std::size_t	coupledPostprocessors (const std::string &param_name) const

const PostprocessorName &	getPostprocessorName (const std::string &param_name, const unsigned int index=0) const

const VectorPostprocessorValue &	getVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name) const

const VectorPostprocessorValue &	getVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name, bool needs_broadcast) const

const VectorPostprocessorValue &	getVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name) const

const VectorPostprocessorValue &	getVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name, bool needs_broadcast) const

const VectorPostprocessorValue &	getVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name) const

const VectorPostprocessorValue &	getVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name, bool needs_broadcast) const

const VectorPostprocessorValue &	getVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name) const

const VectorPostprocessorValue &	getVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name, bool needs_broadcast) const

const ScatterVectorPostprocessorValue &	getScatterVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name) const

const ScatterVectorPostprocessorValue &	getScatterVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name) const

const ScatterVectorPostprocessorValue &	getScatterVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name) const

const ScatterVectorPostprocessorValue &	getScatterVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name) const

bool	hasVectorPostprocessor (const std::string &param_name, const std::string &vector_name) const

bool	hasVectorPostprocessor (const std::string &param_name) const

bool	hasVectorPostprocessorByName (const VectorPostprocessorName &name, const std::string &vector_name) const

bool	hasVectorPostprocessorByName (const VectorPostprocessorName &name) const

const VectorPostprocessorName &	getVectorPostprocessorName (const std::string &param_name) const

T &	getSampler (const std::string &name)

Sampler &	getSampler (const std::string &name)

T &	getSamplerByName (const SamplerName &name)

Sampler &	getSamplerByName (const SamplerName &name)

virtual void	meshChanged ()

virtual void	meshDisplaced ()

PerfGraph &	perfGraph ()

const PostprocessorValue &	getPostprocessorValue (const std::string &param_name, const unsigned int index=0) const

const PostprocessorValue &	getPostprocessorValue (const std::string &param_name, const unsigned int index=0) const

const PostprocessorValue &	getPostprocessorValueOld (const std::string &param_name, const unsigned int index=0) const

const PostprocessorValue &	getPostprocessorValueOld (const std::string &param_name, const unsigned int index=0) const

const PostprocessorValue &	getPostprocessorValueOlder (const std::string &param_name, const unsigned int index=0) const

const PostprocessorValue &	getPostprocessorValueOlder (const std::string &param_name, const unsigned int index=0) const

virtual const PostprocessorValue &	getPostprocessorValueByName (const PostprocessorName &name) const

virtual const PostprocessorValue &	getPostprocessorValueByName (const PostprocessorName &name) const

const PostprocessorValue &	getPostprocessorValueOldByName (const PostprocessorName &name) const

const PostprocessorValue &	getPostprocessorValueOldByName (const PostprocessorName &name) const

const PostprocessorValue &	getPostprocessorValueOlderByName (const PostprocessorName &name) const

const PostprocessorValue &	getPostprocessorValueOlderByName (const PostprocessorName &name) const

bool	isVectorPostprocessorDistributed (const std::string &param_name) const

bool	isVectorPostprocessorDistributed (const std::string &param_name) const

bool	isVectorPostprocessorDistributedByName (const VectorPostprocessorName &name) const

bool	isVectorPostprocessorDistributedByName (const VectorPostprocessorName &name) const

const Distribution &	getDistribution (const std::string &name) const

const T &	getDistribution (const std::string &name) const

const Distribution &	getDistribution (const std::string &name) const

const T &	getDistribution (const std::string &name) const

const Distribution &	getDistributionByName (const DistributionName &name) const

const T &	getDistributionByName (const std::string &name) const

const Distribution &	getDistributionByName (const DistributionName &name) const

const T &	getDistributionByName (const std::string &name) const

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const

Static Public Member Functions
static InputParameters	validParams ()

static void	sort (typename std::vector< T > &vector)

static void	sortDFS (typename std::vector< T > &vector)

static void	cyclicDependencyError (CyclicDependencyException< T2 > &e, const std::string &header)

Public Attributes
const ConsoleStream	_console

Static Public Attributes
static constexpr PropertyValue::id_type	default_property_id

static constexpr PropertyValue::id_type	zero_property_id

static constexpr auto	SYSTEM

static constexpr auto	NAME

Protected Member Functions
virtual std::vector< ADReal >	convert1DInputTo3D (const std::vector< ADReal > &U_1d) const =0
	Converts a 1D flux input vector to a 3D flux input vector. More...

virtual std::vector< ADReal >	convert3DFluxTo1D (const std::vector< ADReal > &F_3d) const =0
	Converts a 3D flux vector to a 1D flux vector. More...

virtual void	transform3DFluxDirection (std::vector< ADReal > &F_3d, Real nLR_dot_d) const =0
	Applies direction transformation to a 3D flux vector. More...

virtual void	addPostprocessorDependencyHelper (const PostprocessorName &name) const override

virtual void	addVectorPostprocessorDependencyHelper (const VectorPostprocessorName &name) const override

virtual void	addUserObjectDependencyHelper (const UserObject &uo) const override

void	addReporterDependencyHelper (const ReporterName &reporter_name) override

const ReporterName &	getReporterName (const std::string &param_name) const

T &	declareRestartableData (const std::string &data_name, Args &&... args)

ManagedValue< T >	declareManagedRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)

const T &	getRestartableData (const std::string &data_name) const

T &	declareRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)

T &	declareRecoverableData (const std::string &data_name, Args &&... args)

T &	declareRestartableDataWithObjectName (const std::string &data_name, const std::string &object_name, Args &&... args)

T &	declareRestartableDataWithObjectNameWithContext (const std::string &data_name, const std::string &object_name, void *context, Args &&... args)

std::string	restartableName (const std::string &data_name) const

const T &	getMeshProperty (const std::string &data_name, const std::string &prefix)

const T &	getMeshProperty (const std::string &data_name)

bool	hasMeshProperty (const std::string &data_name, const std::string &prefix) const

bool	hasMeshProperty (const std::string &data_name, const std::string &prefix) const

bool	hasMeshProperty (const std::string &data_name) const

bool	hasMeshProperty (const std::string &data_name) const

std::string	meshPropertyName (const std::string &data_name) const

PerfID	registerTimedSection (const std::string &section_name, const unsigned int level) const

PerfID	registerTimedSection (const std::string &section_name, const unsigned int level, const std::string &live_message, const bool print_dots=true) const

std::string	timedSectionName (const std::string &section_name) const

bool	isCoupledScalar (const std::string &var_name, unsigned int i=0) const

unsigned int	coupledScalarComponents (const std::string &var_name) const

unsigned int	coupledScalar (const std::string &var_name, unsigned int comp=0) const

libMesh::Order	coupledScalarOrder (const std::string &var_name, unsigned int comp=0) const

const VariableValue &	coupledScalarValue (const std::string &var_name, unsigned int comp=0) const

const ADVariableValue &	adCoupledScalarValue (const std::string &var_name, unsigned int comp=0) const

const GenericVariableValue< is_ad > &	coupledGenericScalarValue (const std::string &var_name, unsigned int comp=0) const

const GenericVariableValue< false > &	coupledGenericScalarValue (const std::string &var_name, const unsigned int comp) const

const GenericVariableValue< true > &	coupledGenericScalarValue (const std::string &var_name, const unsigned int comp) const

const VariableValue &	coupledVectorTagScalarValue (const std::string &var_name, TagID tag, unsigned int comp=0) const

const VariableValue &	coupledMatrixTagScalarValue (const std::string &var_name, TagID tag, unsigned int comp=0) const

const VariableValue &	coupledScalarValueOld (const std::string &var_name, unsigned int comp=0) const

const VariableValue &	coupledScalarValueOlder (const std::string &var_name, unsigned int comp=0) const

const VariableValue &	coupledScalarDot (const std::string &var_name, unsigned int comp=0) const

const ADVariableValue &	adCoupledScalarDot (const std::string &var_name, unsigned int comp=0) const

const VariableValue &	coupledScalarDotDot (const std::string &var_name, unsigned int comp=0) const

const VariableValue &	coupledScalarDotOld (const std::string &var_name, unsigned int comp=0) const

const VariableValue &	coupledScalarDotDotOld (const std::string &var_name, unsigned int comp=0) const

const VariableValue &	coupledScalarDotDu (const std::string &var_name, unsigned int comp=0) const

const VariableValue &	coupledScalarDotDotDu (const std::string &var_name, unsigned int comp=0) const

const MooseVariableScalar *	getScalarVar (const std::string &var_name, unsigned int comp) const

virtual void	checkMaterialProperty (const std::string &name, const unsigned int state)

void	markMatPropRequested (const std::string &)

MaterialPropertyName	getMaterialPropertyName (const std::string &name) const

void	checkExecutionStage ()

const T &	getReporterValue (const std::string &param_name, const std::size_t time_index=0)

const T &	getReporterValue (const std::string &param_name, ReporterMode mode, const std::size_t time_index=0)

const T &	getReporterValue (const std::string &param_name, const std::size_t time_index=0)

const T &	getReporterValue (const std::string &param_name, ReporterMode mode, const std::size_t time_index=0)

const T &	getReporterValueByName (const ReporterName &reporter_name, const std::size_t time_index=0)

const T &	getReporterValueByName (const ReporterName &reporter_name, ReporterMode mode, const std::size_t time_index=0)

const T &	getReporterValueByName (const ReporterName &reporter_name, const std::size_t time_index=0)

const T &	getReporterValueByName (const ReporterName &reporter_name, ReporterMode mode, const std::size_t time_index=0)

bool	hasReporterValue (const std::string &param_name) const

bool	hasReporterValue (const std::string &param_name) const

bool	hasReporterValue (const std::string &param_name) const

bool	hasReporterValue (const std::string &param_name) const

bool	hasReporterValueByName (const ReporterName &reporter_name) const

bool	hasReporterValueByName (const ReporterName &reporter_name) const

bool	hasReporterValueByName (const ReporterName &reporter_name) const

bool	hasReporterValueByName (const ReporterName &reporter_name) const

const GenericMaterialProperty< T, is_ad > *	defaultGenericMaterialProperty (const std::string &name)

const GenericMaterialProperty< T, is_ad > *	defaultGenericMaterialProperty (const std::string &name)

const MaterialProperty< T > *	defaultMaterialProperty (const std::string &name)

const MaterialProperty< T > *	defaultMaterialProperty (const std::string &name)

const ADMaterialProperty< T > *	defaultADMaterialProperty (const std::string &name)

const ADMaterialProperty< T > *	defaultADMaterialProperty (const std::string &name)

Static Protected Member Functions
static std::string	meshPropertyName (const std::string &data_name, const std::string &prefix)

Protected Attributes
unsigned int	_cached_flux_elem_id
	element ID of the cached flux values More...

unsigned int	_cached_flux_side_id
	side ID of the cached flux values More...

std::vector< ADReal >	_FL_3d
	flux vector for the "left" cell for 3D More...

std::vector< ADReal >	_FR_3d
	flux vector for the "right" cell for 3D More...

std::vector< ADReal >	_FL_1d
	flux vector for the "left" cell for 1D More...

std::vector< ADReal >	_FR_1d
	flux vector for the "right" cell for 1D More...

unsigned int	_last_region_index
	Index describing the region last entered, which is useful for testing and debugging. More...

SubProblem &	_subproblem

FEProblemBase &	_fe_problem

SystemBase &	_sys

const THREAD_ID	_tid

Assembly &	_assembly

const Moose::CoordinateSystemType &	_coord_sys

const bool	_duplicate_initial_execution

std::set< std::string >	_depend_uo

const bool &	_enabled

MooseApp &	_app

const std::string	_type

const std::string	_name

const InputParameters &	_pars

Factory &	_factory

ActionFactory &	_action_factory

const ExecFlagEnum &	_execute_enum

const ExecFlagType &	_current_execute_flag

MooseApp &	_restartable_app

const std::string	_restartable_system_name

const THREAD_ID	_restartable_tid

const bool	_restartable_read_only

FEProblemBase &	_mci_feproblem

FEProblemBase &	_mdi_feproblem

MooseApp &	_pg_moose_app

const std::string	_prefix

FEProblemBase &	_sc_fe_problem

const THREAD_ID	_sc_tid

const Real &	_real_zero

const VariableValue &	_scalar_zero

const Point &	_point_zero

const InputParameters &	_mi_params

const std::string	_mi_name

const MooseObjectName	_mi_moose_object_name

FEProblemBase &	_mi_feproblem

SubProblem &	_mi_subproblem

const THREAD_ID	_mi_tid

const Moose::MaterialDataType	_material_data_type

MaterialData &	_material_data

bool	_stateful_allowed

bool	_get_material_property_called

std::vector< std::unique_ptr< PropertyValue > >	_default_properties

std::unordered_set< unsigned int >	_material_property_dependencies

const MaterialPropertyName	_get_suffix

const bool	_use_interpolated_state

const InputParameters &	_ti_params

FEProblemBase &	_ti_feproblem

bool	_is_implicit

Real &	_t

const Real &	_t_old

int &	_t_step

Real &	_dt

Real &	_dt_old

bool	_is_transient

const Parallel::Communicator &	_communicator

Static Protected Attributes
static const std::string	_interpolated_old

static const std::string	_interpolated_older

Detailed Description

Abstract base class for computing and caching internal or boundary fluxes for 1D conservation law systems.

Definition at line 18 of file NumericalFlux1D.h.

Constructor & Destructor Documentation

◆ NumericalFlux1D()

NumericalFlux1D::NumericalFlux1D ( const InputParameters & parameters )

Definition at line 20 of file NumericalFlux1D.C.

   : ThreadedGeneralUserObject(parameters),
 
     _cached_flux_elem_id(libMesh::invalid_uint),
     _cached_flux_side_id(libMesh::invalid_uint),
 
     _last_region_index(0)
 {
 }

Member Function Documentation

◆ calcFlux()

virtual void NumericalFlux1D::calcFlux	(	const std::vector< ADReal > &	UL_3d,
		const std::vector< ADReal > &	UR_3d,
		const RealVectorValue &	nLR,
		const RealVectorValue &	t1,
		const RealVectorValue &	t2,
		std::vector< ADReal > &	FL,
		std::vector< ADReal > &	FR
	)		const

pure virtual

Calculates the 3D flux vectors given "left" and "right" states.

This function is called only if the values are not already cached.

Parameters

[in]	UL_3d	Vector of 3D flux inputs on the "left"
[in]	UR_3d	Vector of 3D flux inputs on the "right"
[in]	nLR	Direction from "left" to "right"
[in]	t1	1st tangent direction
[in]	t2	2nd tangent direction
[out]	FL	Flux vector to be added to "left" side
[out]	FR	Flux vector to be added to "right" side

Implemented in ADNumericalFlux3EqnHLLC, NumericalFluxGasMixHLLC, and ADNumericalFlux3EqnCentered.

Referenced by getFlux(), and getFlux3D().

◆ convert1DInputTo3D()

virtual std::vector<ADReal> NumericalFlux1D::convert1DInputTo3D ( const std::vector< ADReal > & U_1d ) const

protectedpure virtual

Converts a 1D flux input vector to a 3D flux input vector.

Parameters

[in] U_1d 1D flux input vector

Implemented in ADNumericalFlux3EqnBase, and NumericalFluxGasMixBase.

Referenced by getFlux().

◆ convert3DFluxTo1D()

virtual std::vector<ADReal> NumericalFlux1D::convert3DFluxTo1D ( const std::vector< ADReal > & F_3d ) const

protectedpure virtual

Converts a 3D flux vector to a 1D flux vector.

Parameters

[in] F_3d 3D flux vector

Implemented in ADNumericalFlux3EqnBase, and NumericalFluxGasMixBase.

Referenced by getFlux().

◆ execute()

void NumericalFlux1D::execute ( )

overridevirtual

Implements ThreadedGeneralUserObject.

Definition at line 38 of file NumericalFlux1D.C.

39 {

40 }

◆ finalize()

void NumericalFlux1D::finalize ( )

overridevirtual

Implements ThreadedGeneralUserObject.

Definition at line 43 of file NumericalFlux1D.C.

44 {

45 }

◆ getFlux()

const std::vector< ADReal > & NumericalFlux1D::getFlux	(	const unsigned int	iside,
		const dof_id_type	ielem,
		bool	res_side_is_left,
		const std::vector< ADReal > &	UL_1d,
		const std::vector< ADReal > &	UR_1d,
		Real	nLR_dot_d
	)		const

virtual

Gets the 1D flux vector for an element/side combination.

If the element/side is cached, the cached values are used. Otherwise the values are computed, cached, and returned.

Parameters

[in]	iside	local index of current side
[in]	ielem	global index of the current element
[in]	res_side_is_left	getting flux on the left ("elem") side?
[in]	UL_1d	vector of 1D flux inputs on the "left"
[in]	UR_1d	vector of 1D flux inputs on the "right"
[in]	nLR_dot_d	Dot product of direction from "left" to "right" with the flow channel direction

Returns: flux vector for an element/side combination

Definition at line 53 of file NumericalFlux1D.C.

Referenced by ADBoundaryFlux3EqnGhostBase::calcFlux(), BoundaryFluxGasMixGhostBase::calcFlux(), NumericalFluxGasMixDGKernel::computeQpResidual(), ADNumericalFlux3EqnDGKernel::computeQpResidual(), ADGateValve1PhaseUserObject::finalize(), and ADJunctionOneToOne1PhaseUserObject::finalize().

 {
   if (_cached_flux_elem_id != ielem || _cached_flux_side_id != iside)
   {
     _cached_flux_elem_id = ielem;
     _cached_flux_side_id = iside;
 
     const auto UL_3d = convert1DInputTo3D(UL_1d);
     const auto UR_3d = convert1DInputTo3D(UR_1d);
 
     const RealVectorValue nLR(nLR_dot_d, 0, 0);
     RealVectorValue t1, t2;
     THM::computeOrthogonalDirections(nLR, t1, t2);
 
     calcFlux(UL_3d, UR_3d, nLR, t1, t2, _FL_3d, _FR_3d);
 
     transform3DFluxDirection(_FL_3d, nLR_dot_d);
     transform3DFluxDirection(_FR_3d, nLR_dot_d);
 
     _FL_1d = convert3DFluxTo1D(_FL_3d);
     _FR_1d = convert3DFluxTo1D(_FR_3d);
   }
 
   if (res_side_is_left)
     return _FL_1d;
   else
     return _FR_1d;
 }

◆ getFlux3D()

const std::vector< ADReal > & NumericalFlux1D::getFlux3D	(	const unsigned int	iside,
		const dof_id_type	ielem,
		const std::vector< ADReal > &	UL_3d,
		const std::vector< ADReal > &	UR_3d,
		const RealVectorValue &	nLR,
		const RealVectorValue &	t1,
		const RealVectorValue &	t2
	)		const

virtual

Gets the 3D flux vector for an element/side combination on the left side.

If the element/side is cached, the cached values are used. Otherwise the values are computed, cached, and returned.

Parameters

[in]	iside	local index of current side
[in]	ielem	global index of the current element
[in]	UL_3d	vector of 3D flux inputs on the "left"
[in]	UR_3d	vector of 3D flux inputs on the "right"
[in]	nLR	Direction from "left" to "right"
[in]	t1	1st tangent direction
[in]	t2	2nd tangent direction

Returns: flux vector for an element/side combination

Definition at line 88 of file NumericalFlux1D.C.

 {
   if (_cached_flux_elem_id != ielem || _cached_flux_side_id != iside)
   {
     _cached_flux_elem_id = ielem;
     _cached_flux_side_id = iside;
 
     calcFlux(UL_3d, UR_3d, nLR, t1, t2, _FL_3d, _FR_3d);
   }
 
   return _FL_3d;
 }

◆ getLastRegionIndex()

unsigned int NumericalFlux1D::getLastRegionIndex ( ) const

inline

Returns the index of the region last entered.

Here "region" refers to a code path taken. For some fluxes, such as centered fluxes, there is just a single code path, but for others, such as those using an approximate Riemann solver, there are multiple. Riemann solvers have "regions" defined by the characteristic waves.

Definition at line 106 of file NumericalFlux1D.h.

106 { return _last_region_index; }

NumericalFlux1D::_last_region_index

unsigned int _last_region_index

Index describing the region last entered, which is useful for testing and debugging.

Definition: NumericalFlux1D.h:157

◆ getNumberOfRegions()

virtual unsigned int NumericalFlux1D::getNumberOfRegions ( ) const

pure virtual

Returns the total possible number of regions.

Here "region" refers to a code path taken. For some fluxes, such as centered fluxes, there is just a single code path, but for others, such as those using an approximate Riemann solver, there are multiple. Riemann solvers have "regions" defined by the characteristic waves.

Implemented in ADNumericalFlux3EqnHLLC, NumericalFluxGasMixHLLC, and ADNumericalFlux3EqnCentered.

◆ initialize()

void NumericalFlux1D::initialize ( )

overridevirtual

Implements ThreadedGeneralUserObject.

Definition at line 31 of file NumericalFlux1D.C.

 {
   _cached_flux_elem_id = libMesh::invalid_uint;
   _cached_flux_side_id = libMesh::invalid_uint;
 }

◆ threadJoin()

void NumericalFlux1D::threadJoin ( const UserObject & )

overridevirtual

Reimplemented from ThreadedGeneralUserObject.

Definition at line 48 of file NumericalFlux1D.C.

49 {

50 }

◆ transform3DFluxDirection()

virtual void NumericalFlux1D::transform3DFluxDirection	(	std::vector< ADReal > &	F_3d,
		Real	nLR_dot_d
	)		const

protectedpure virtual

Applies direction transformation to a 3D flux vector.

Parameters

[in,out]	F_3d	3D flux vector
[in]	nLR_dot_d	Dot product of direction from "left" to "right" with the flow channel direction

Implemented in ADNumericalFlux3EqnBase, and NumericalFluxGasMixBase.

Referenced by getFlux().

◆ validParams()

InputParameters NumericalFlux1D::validParams ( )

static

Definition at line 14 of file NumericalFlux1D.C.

Referenced by ADNumericalFlux3EqnBase::validParams(), and NumericalFluxGasMixBase::validParams().

 {
   InputParameters params = GeneralUserObject::validParams();
   return params;
 }

Member Data Documentation

◆ _cached_flux_elem_id

unsigned int NumericalFlux1D::_cached_flux_elem_id

mutableprotected

element ID of the cached flux values

Definition at line 143 of file NumericalFlux1D.h.

Referenced by getFlux(), getFlux3D(), and initialize().

◆ _cached_flux_side_id

unsigned int NumericalFlux1D::_cached_flux_side_id

mutableprotected

side ID of the cached flux values

Definition at line 145 of file NumericalFlux1D.h.

Referenced by getFlux(), getFlux3D(), and initialize().

◆ _FL_1d

std::vector<ADReal> NumericalFlux1D::_FL_1d

mutableprotected

flux vector for the "left" cell for 1D

Definition at line 152 of file NumericalFlux1D.h.

Referenced by getFlux().

◆ _FL_3d

std::vector<ADReal> NumericalFlux1D::_FL_3d

mutableprotected

flux vector for the "left" cell for 3D

Definition at line 148 of file NumericalFlux1D.h.

Referenced by getFlux(), and getFlux3D().

◆ _FR_1d

std::vector<ADReal> NumericalFlux1D::_FR_1d

mutableprotected

flux vector for the "right" cell for 1D

Definition at line 154 of file NumericalFlux1D.h.

Referenced by getFlux().

◆ _FR_3d

std::vector<ADReal> NumericalFlux1D::_FR_3d

mutableprotected

flux vector for the "right" cell for 3D

Definition at line 150 of file NumericalFlux1D.h.

Referenced by getFlux(), and getFlux3D().

◆ _last_region_index

unsigned int NumericalFlux1D::_last_region_index

mutableprotected

Index describing the region last entered, which is useful for testing and debugging.

Definition at line 157 of file NumericalFlux1D.h.

Referenced by NumericalFluxGasMixHLLC::calcFlux(), ADNumericalFlux3EqnHLLC::calcFlux(), and getLastRegionIndex().

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

thermal_hydraulics/include/userobjects/NumericalFlux1D.h
thermal_hydraulics/src/userobjects/NumericalFlux1D.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ NumericalFlux1D()

Member Function Documentation

◆ calcFlux()

◆ convert1DInputTo3D()

◆ convert3DFluxTo1D()

◆ execute()

◆ finalize()

◆ getFlux()

◆ getFlux3D()

◆ getLastRegionIndex()

◆ getNumberOfRegions()

◆ initialize()

◆ threadJoin()

◆ transform3DFluxDirection()

◆ validParams()

Member Data Documentation

◆ _cached_flux_elem_id

◆ _cached_flux_side_id

◆ _FL_1d

◆ _FL_3d

◆ _FR_1d

◆ _FR_3d

◆ _last_region_index