https://mooseframework.inl.gov
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Protected Attributes | Private Member Functions | Static Private Member Functions | Private Attributes | List of all members
LinearFVPhaseChangeSource Class Reference

Finite-volume elemental kernel that adds the apparent heat-capacity phase-change source term: rho * L * (df/dT) * T_dot. More...

#include <LinearFVPhaseChangeSource.h>

Inheritance diagram for LinearFVPhaseChangeSource:
[legend]

Public Types

enum  ResidualTagType
 
typedef DataFileName DataFileParameterType
 

Public Member Functions

 LinearFVPhaseChangeSource (const InputParameters &params)
 Constructor.
 
Real computeMatrixContribution () override
 
Real computeRightHandSideContribution () override
 
virtual void setCurrentElemInfo (const ElemInfo *elem_info) override
 
virtual void addMatrixContribution () override
 
virtual void addRightHandSideContribution () override
 
void setCurrentElemVolume (const Real volume)
 
virtual const MooseLinearVariableFV< Real > & variable () const override
 
void linkTaggedVectorsAndMatrices (const std::set< TagID > &vector_tags, const std::set< TagID > &matrix_tags)
 
virtual bool enabled () const
 
std::shared_ptr< MooseObject > getSharedPtr ()
 
std::shared_ptr< const MooseObject > getSharedPtr () const
 
bool isKokkosObject () const
 
MooseApp & getMooseApp () const
 
const std::string & type () const
 
const std::string & name () const
 
std::string typeAndName () const
 
MooseObjectParameterName uniqueParameterName (const std::string &parameter_name) const
 
MooseObjectName uniqueName () const
 
const InputParameters & parameters () const
 
const hit::Node * getHitNode () const
 
bool hasBase () const
 
const std::string & getBase () 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 &name) const
 
void connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const
 
void paramError (const std::string &param, Args... args) const
 
void paramWarning (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
 
std::string messagePrefix (const bool hit_prefix=true) const
 
std::string errorPrefix (const std::string &) const
 
void mooseError (Args &&... args) const
 
void mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const
 
void mooseErrorNonPrefixed (Args &&... args) const
 
void mooseWarning (Args &&... args) const
 
void mooseWarning (Args &&... args) const
 
void mooseWarningNonPrefixed (Args &&... args) const
 
void mooseWarningNonPrefixed (Args &&... args) const
 
void mooseDeprecated (Args &&... args) const
 
void mooseDeprecated (Args &&... args) const
 
void mooseDeprecatedNoTrace (Args &&... args) const
 
void mooseInfo (Args &&... args) const
 
void callMooseError (std::string msg, const bool with_prefix, const hit::Node *node=nullptr, const bool show_trace=true) 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 subdomainSetup ()
 
virtual void customSetup (const ExecFlagType &)
 
const ExecFlagEnum & getExecuteOnEnum () const
 
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
 
Moose::Kokkos::Function getKokkosFunction (const std::string &name) const
 
const T & getKokkosFunction (const std::string &name) const
 
Moose::Kokkos::Function getKokkosFunctionByName (const FunctionName &name) const
 
const T & getKokkosFunctionByName (const FunctionName &name) const
 
bool hasKokkosFunction (const std::string &param_name) const
 
bool hasKokkosFunctionByName (const FunctionName &name) 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 UserObjectBase & getUserObjectBase (const std::string &param_name, bool is_dependency=true) const
 
const UserObjectBase & getUserObjectBaseByName (const UserObjectName &object_name, bool is_dependency=true) const
 
bool isImplicit ()
 
Moose::StateArg determineState () 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
 
void setRandomResetFrequency (ExecFlagType exec_flag)
 
unsigned long getRandomLong () const
 
Real getRandomReal () const
 
unsigned int getSeed (std::size_t id)
 
unsigned int getMasterSeed () const
 
bool isNodal () const
 
ExecFlagType getResetOnTime () const
 
void setRandomDataPointer (RandomData *random_data)
 
virtual void meshChanged ()
 
void useVectorTag (const TagName &tag_name, VectorTagsKey)
 
void useVectorTag (TagID tag_id, VectorTagsKey)
 
void useMatrixTag (const TagName &tag_name, MatrixTagsKey)
 
void useMatrixTag (TagID tag_id, MatrixTagsKey)
 
bool isVectorTagged ()
 
bool isMatrixTagged ()
 
bool hasVectorTags () const
 
const std::set< TagID > & getVectorTags (VectorTagsKey) const
 
const std::set< TagID > & getMatrixTags (MatrixTagsKey) const
 
const std::vector< SubdomainName > & blocks () const
 
unsigned int numBlocks () const
 
virtual const std::set< SubdomainID > & blockIDs () const
 
unsigned int blocksMaxDimension () const
 
bool hasBlocks (const SubdomainName &name) const
 
bool hasBlocks (const std::vector< SubdomainName > &names) const
 
bool hasBlocks (const std::set< SubdomainName > &names) const
 
bool hasBlocks (SubdomainID id) const
 
bool hasBlocks (const std::vector< SubdomainID > &ids) const
 
bool hasBlocks (const std::set< SubdomainID > &ids) const
 
bool isBlockSubset (const std::set< SubdomainID > &ids) const
 
bool isBlockSubset (const std::vector< SubdomainID > &ids) const
 
bool hasBlockMaterialProperty (const std::string &prop_name)
 
const std::set< SubdomainID > & meshBlockIDs () const
 
virtual bool blockRestricted () const
 
virtual void checkVariable (const MooseVariableFieldBase &variable) const
 
const Moose::Functor< Real > * defaultFunctor (const std::string &name)
 
const Moose::Functor< ADReal > * defaultFunctor (const std::string &name)
 
MooseVariableBase * mooseVariableBase () const
 
MooseVariableField< Real > & mooseVariableField ()
 
MooseVariableFE< Real > * mooseVariable () const
 
MooseVariableFV< Real > * mooseVariableFV () const
 
MooseLinearVariableFV< Real > * mooseLinearVariableFV () const
 
const std::set< MooseVariableFieldBase * > & getMooseVariableDependencies () const
 
std::set< MooseVariableFieldBase * > checkAllVariables (const DofObjectType &dof_object, const std::set< MooseVariableFieldBase * > &vars_to_omit={})
 
virtual std::set< MooseVariableFieldBase * > checkVariables (const libMesh::Node &node, const std::set< MooseVariableFieldBase * > &vars_to_check)
 
std::set< MooseVariableFieldBase * > checkVariables (const libMesh::Elem &element, const std::set< MooseVariableFieldBase * > &vars_to_check)
 
void addMooseVariableDependency (MooseVariableFieldBase *var)
 
void addMooseVariableDependency (const std::vector< MooseVariableFieldBase * > &vars)
 
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 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 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 callMooseError (MooseApp *const app, const InputParameters &params, std::string msg, const bool with_prefix, const hit::Node *node, const bool show_trace=true)
 
static std::string deduceFunctorName (const std::string &name, const InputParameters &params)
 
static void setRMParamsAdvection (const InputParameters &obj_params, InputParameters &rm_params, const unsigned short conditional_extended_layers)
 
static void setRMParamsDiffusion (const InputParameters &obj_params, InputParameters &rm_params, const unsigned short conditional_extended_layers)
 

Public Attributes

 usingCombinedWarningSolutionWarnings
 
const ConsoleStream _console
 

Static Public Attributes

static const std::string type_param
 
static const std::string name_param
 
static const std::string unique_name_param
 
static const std::string app_param
 
static const std::string moose_base_param
 
static const std::string kokkos_object_param
 

Protected Member Functions

std::string deduceFunctorName (const std::string &name) const
 
void requestVariableCellGradient (const std::string &variable_name)
 
void flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const
 
InvalidSolutionID registerInvalidSolutionInternal (const std::string &message, const bool warning) const
 
virtual void addUserObjectDependencyHelper (const UserObjectBase &) const
 
virtual void addPostprocessorDependencyHelper (const PostprocessorName &) const
 
virtual void addVectorPostprocessorDependencyHelper (const VectorPostprocessorName &) 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
 
void prepareVectorTag (Assembly &assembly, unsigned int ivar)
 
void prepareVectorTag (Assembly &assembly, unsigned int ivar, ResidualTagType tag_type)
 
void prepareVectorTag (Assembly &assembly, unsigned int ivar, ResidualTagType tag_type)
 
void prepareVectorTag (Assembly &assembly, unsigned int ivar, ResidualTagType tag_type)
 
void prepareVectorTag (Assembly &assembly, unsigned int ivar, ResidualTagType tag_type)
 
void prepareVectorTagNeighbor (Assembly &assembly, unsigned int ivar)
 
void prepareVectorTagLower (Assembly &assembly, unsigned int ivar)
 
void prepareMatrixTag (Assembly &assembly, unsigned int ivar, unsigned int jvar)
 
void prepareMatrixTag (Assembly &assembly, unsigned int ivar, unsigned int jvar, DenseMatrix< Number > &k) const
 
void prepareMatrixTagNonlocal (Assembly &assembly, unsigned int ivar, unsigned int jvar)
 
void prepareMatrixTagNeighbor (Assembly &assembly, unsigned int ivar, unsigned int jvar, Moose::DGJacobianType type)
 
void prepareMatrixTagNeighbor (Assembly &assembly, unsigned int ivar, unsigned int jvar, Moose::DGJacobianType type, DenseMatrix< Number > &k) const
 
void prepareMatrixTagLower (Assembly &assembly, unsigned int ivar, unsigned int jvar, Moose::ConstraintJacobianType type)
 
void accumulateTaggedLocalResidual ()
 
void assignTaggedLocalResidual ()
 
void accumulateTaggedLocalMatrix ()
 
void accumulateTaggedLocalMatrix (Assembly &assembly, unsigned int ivar, unsigned int jvar, const DenseMatrix< Number > &k)
 
void accumulateTaggedLocalMatrix (Assembly &assembly, unsigned int ivar, unsigned int jvar, Moose::DGJacobianType type, const DenseMatrix< Number > &k)
 
void accumulateTaggedNonlocalMatrix ()
 
void assignTaggedLocalMatrix ()
 
void addResiduals (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
 
void addResiduals (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, const std::vector< Real > &scaling_factors)
 
void addResiduals (Assembly &assembly, const DenseVector< T > &residuals, const Indices &dof_indices, Real scaling_factor)
 
void addResiduals (Assembly &assembly, const ADResidualsPacket &packet)
 
void addResidualsAndJacobian (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
 
void addResidualsAndJacobian (Assembly &assembly, const ADResidualsPacket &packet)
 
void addJacobian (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
 
void addJacobian (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, const std::vector< Real > &scaling_factors)
 
void addJacobian (Assembly &assembly, const ADResidualsPacket &packet)
 
void addJacobian (Assembly &assembly, const DenseMatrix< Real > &local_k, const std::vector< dof_id_type > &row_indices, const std::vector< dof_id_type > &column_indices, Real scaling_factor)
 
void addResidualsWithoutConstraints (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
 
void addResidualsAndJacobianWithoutConstraints (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
 
void addJacobianWithoutConstraints (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
 
void addJacobianElement (Assembly &assembly, Real value, dof_id_type row_index, dof_id_type column_index, Real scaling_factor)
 
void setResidual (SystemBase &sys, const T &residual, MooseVariableFE< T > &var)
 
void setResidual (SystemBase &sys, Real residual, dof_id_type dof_index)
 
void setResidual (SystemBase &sys, SetResidualFunctor set_residual_functor)
 
virtual bool hasBlockMaterialPropertyHelper (const std::string &prop_name)
 
void initializeBlockRestrictable (const MooseObject *moose_object)
 
void initializeKokkosBlockRestrictable ()
 
Moose::CoordinateSystemType getBlockCoordSystem ()
 
KOKKOS_FUNCTION dof_id_type numKokkosBlockElements () const
 
KOKKOS_FUNCTION dof_id_type numKokkosBlockNodes () const
 
KOKKOS_FUNCTION dof_id_type numKokkosBlockSides () const
 
KOKKOS_FUNCTION ContiguousElementID kokkosBlockElementID (Moose::Kokkos::ThreadID tid) const
 
KOKKOS_FUNCTION ContiguousElementID kokkosBlockNodeID (Moose::Kokkos::ThreadID tid) const
 
KOKKOS_FUNCTION auto kokkosBlockElementSideID (Moose::Kokkos::ThreadID tid) const
 
const Moose::Functor< T > & getFunctor (const std::string &name)
 
const Moose::Functor< T > & getFunctor (const std::string &name, THREAD_ID tid)
 
const Moose::Functor< T > & getFunctor (const std::string &name, SubProblem &subproblem)
 
const Moose::Functor< T > & getFunctor (const std::string &name, SubProblem &subproblem, THREAD_ID tid)
 
bool isFunctor (const std::string &name) const
 
bool isFunctor (const std::string &name, const SubProblem &subproblem) const
 
Moose::ElemArg makeElemArg (const Elem *elem, bool correct_skewnewss=false) const
 
void checkFunctorSupportsSideIntegration (const std::string &name, bool qp_integration)
 
const Moose::Functor< T > & getFunctorByName (const std::string &name)
 
virtual const OutputTools< Real >::VariableValue & value ()
 
virtual const OutputTools< Real >::VariableValue & valueOld ()
 
virtual const OutputTools< Real >::VariableValue & valueOlder ()
 
virtual const OutputTools< Real >::VariableValue & dot ()
 
virtual const OutputTools< Real >::VariableValue & dotDot ()
 
virtual const OutputTools< Real >::VariableValue & dotOld ()
 
virtual const OutputTools< Real >::VariableValue & dotDotOld ()
 
virtual const VariableValue & dotDu ()
 
virtual const VariableValue & dotDotDu ()
 
virtual const OutputTools< Real >::VariableGradient & gradient ()
 
virtual const OutputTools< Real >::VariableGradient & gradientOld ()
 
virtual const OutputTools< Real >::VariableGradient & gradientOlder ()
 
virtual const OutputTools< Real >::VariableSecond & second ()
 
virtual const OutputTools< Real >::VariableSecond & secondOld ()
 
virtual const OutputTools< Real >::VariableSecond & secondOlder ()
 
virtual const OutputTools< Real >::VariableTestSecond & secondTest ()
 
virtual const OutputTools< Real >::VariableTestSecond & secondTestFace ()
 
virtual const OutputTools< Real >::VariablePhiSecond & secondPhi ()
 
virtual const OutputTools< Real >::VariablePhiSecond & secondPhiFace ()
 

Protected Attributes

const Moose::Functor< Real > & _L
 Latent heat.
 
const Moose::Functor< Real > & _rho
 Density.
 
const Moose::Functor< Real > & _T_solidus
 Solidus Temperature.
 
const Moose::Functor< Real > & _T_liquidus
 Liquidus Temperature.
 
const bool _smooth
 Whether to use the smoothstep liquid fraction (true, default) or the linear ("sharp") liquid fraction (false)
 
const TimeIntegrator & _time_integrator
 The time integrator to use in this kernel, will provide information on how many states are required in the history.
 
const ElemInfo * _current_elem_info
 
Real _current_elem_volume
 
dof_id_type _dof_id
 
MooseLinearVariableFV< Real > & _var
 
const unsigned int _var_num
 
const unsigned int _sys_num
 
FEProblemBase & _fe_problem
 
SystemBase & _sys
 
libMesh::LinearImplicitSystem & _linear_system
 
const THREAD_ID _tid
 
MooseMesh & _mesh
 
std::vector< NumericVector< Number > * > _vectors
 
std::vector< SparseMatrix< Number > * > _matrices
 
const bool & _enabled
 
MooseApp & _app
 
Factory & _factory
 
ActionFactory & _action_factory
 
const std::string & _type
 
const std::string & _name
 
const InputParameters & _pars
 
const ExecFlagEnum & _execute_enum
 
const ExecFlagType & _current_execute_flag
 
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
 
MooseApp & _restartable_app
 
const std::string _restartable_system_name
 
const THREAD_ID _restartable_tid
 
const bool _restartable_read_only
 
FEProblemBase & _mci_feproblem
 
SubProblem & _subproblem
 
DenseVector< Number > _local_re
 
DenseMatrix< Number > _local_ke
 
DenseMatrix< Number > _nonlocal_ke
 
const MaterialData * _blk_material_data
 
bool _nodal
 
MooseVariableFE< Real > * _variable
 
MooseVariableFV< Real > * _fv_variable
 
MooseLinearVariableFV< Real > * _linear_fv_variable
 
MooseVariableField< Real > * _field_variable
 
Assembly * _mvi_assembly
 
const Parallel::Communicator & _communicator
 

Private Member Functions

Real computeDfDT (const Real T, const Real T_sol, const Real dT_pc) const
 Compute df/dT at temperature T for the selected liquid-fraction shape.
 
const Moose::Functor< T > * defaultFunctor (const std::string &name)
 
const Moose::Functor< Real > * defaultFunctor (const std::string &name)
 
const Moose::Functor< ADReal > * defaultFunctor (const std::string &name)
 
const Moose::Functor< T > & getFunctorByName (const std::string &name, SubProblem &subproblem, THREAD_ID tid)
 
const Moose::FunctionBase * getKokkosFunctionByNameHelper (const FunctionName &name) const
 
const UserObjectBase & getUserObjectFromFEProblem (const UserObjectName &object_name, const THREAD_ID tid=0) const
 
const T & castUserObject (const UserObjectBase &uo_base, const std::string &param_name="") const
 
void mooseObjectError (const std::string &param_name, std::stringstream &oss) const
 
const std::string & userObjectType (const UserObjectBase &uo) const
 
const std::string & userObjectName (const UserObjectBase &uo) const
 
const PostprocessorName & getPostprocessorNameInternal (const std::string &param_name, const unsigned int index, const bool allow_default_value=true) const
 
bool isDefaultPostprocessorValueByName (const PostprocessorName &name) const
 
PostprocessorValue getDefaultPostprocessorValueByName (const PostprocessorName &name) const
 
void checkParam (const std::string &param_name, const unsigned int index=std::numeric_limits< unsigned int >::max()) const
 
bool postprocessorsAdded () const
 
const VectorPostprocessorValue & getVectorPostprocessorByNameHelper (const VectorPostprocessorName &name, const std::string &vector_name, bool broadcast, std::size_t t_index) const
 
const VectorPostprocessorContext< VectorPostprocessorValue > & getVectorPostprocessorContextByNameHelper (const VectorPostprocessorName &name, const std::string &vector_name) const
 
bool vectorPostprocessorsAdded () const
 
RestartableDataValue & registerRestartableDataOnApp (std::unique_ptr< RestartableDataValue > data, THREAD_ID tid) const
 
void registerRestartableNameWithFilterOnApp (const std::string &name, Moose::RESTARTABLE_FILTER filter)
 
RestartableData< T > & declareRestartableDataHelper (const std::string &data_name, void *context, Args &&... args) const
 
void prepareVectorTagInternal (Assembly &assembly, unsigned int ivar, const std::set< TagID > &vector_tags, const std::set< TagID > &absolute_value_vector_tags)
 
void checkForNans () const
 
virtual bool isADObject () const override
 
std::set< MooseVariableFieldBase * > checkVariablesHelper (const DofObjectType &dof_object, const std::set< MooseVariableFieldBase * > &vars_to_check)
 
const PostprocessorValue & getPostprocessorValueInternal (const std::string &param_name, unsigned int index, std::size_t t_index) const
 
const PostprocessorValue & getPostprocessorValueInternal (const std::string &param_name, unsigned int index, std::size_t t_index) const
 
const PostprocessorValue & getPostprocessorValueByNameInternal (const PostprocessorName &name, std::size_t t_index) const
 
const PostprocessorValue & getPostprocessorValueByNameInternal (const PostprocessorName &name, std::size_t t_index) const
 
void possiblyCheckHasVectorPostprocessor (const std::string &param_name, const std::string &vector_name) const
 
void possiblyCheckHasVectorPostprocessor (const std::string &param_name, const std::string &vector_name) const
 
void possiblyCheckHasVectorPostprocessorByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
void possiblyCheckHasVectorPostprocessorByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 

Static Private Member Functions

static const hit::Node * getHitNode (const InputParameters &params)
 
static std::string messagePrefix (const InputParameters &params, const bool hit_prefix)
 
static void setRMParams (const InputParameters &obj_params, InputParameters &rm_params, const unsigned short ghost_layers)
 
static void parameterError (const InputParameters &obj_params, const std::string &parameter_name, const std::string &function_name, const std::string &description)
 

Private Attributes

std::vector< Real > _factor_history
 Current and older values of the material property multiplier.
 
std::vector< Moose::StateArg > _state_args
 State args, the args which will help us fetch the different states of the material property multiplier.
 
const ParallelParamObject & _parent
 
const MooseBase & _si_moose_base
 
const FEProblemBase * _si_problem
 
ExecFlagEnum _empty_execute_enum
 
const MooseObject & _fni_object
 
const InputParameters & _fni_params
 
FEProblemBase & _fni_feproblem
 
const THREAD_ID _fni_tid
 
const MooseObject & _uoi_moose_object
 
const FEProblemBase & _uoi_feproblem
 
const THREAD_ID _uoi_tid
 
const std::string _ti_name
 
const MooseObject & _ppi_moose_object
 
const InputParameters & _ppi_params
 
const FEProblemBase & _ppi_feproblem
 
std::map< PostprocessorName, std::unique_ptr< PostprocessorValue > > _default_values
 
const bool _broadcast_by_default
 
const MooseObject & _vpi_moose_object
 
const FEProblemBase & _vpi_feproblem
 
const THREAD_ID _vpi_tid
 
RandomData * _random_data
 
MooseRandom * _generator
 
FEProblemBase & _ri_problem
 
const std::string _ri_name
 
unsigned int _master_seed
 
bool _is_nodal
 
ExecFlagType _reset_on
 
const Node *const & _curr_node
 
const Elem *const & _curr_element
 
const RestartableDataMapName _metaname
 
std::string _restartable_name
 
std::set< TagID > _vector_tags
 
std::set< TagID > _abs_vector_tags
 
std::set< TagID > _matrix_tags
 
std::set< TagID > _non_ref_vector_tags
 
std::set< TagID > _non_ref_abs_vector_tags
 
std::set< TagID > _ref_vector_tags
 
std::set< TagID > _ref_abs_vector_tags
 
const MooseObject & _moose_object
 
const InputParameters & _tag_params
 
std::vector< DenseVector< Number > * > _re_blocks
 
std::vector< DenseVector< Number > * > _absre_blocks
 
std::vector< DenseMatrix< Number > * > _ke_blocks
 
std::vector< Real > _absolute_residuals
 
std::set< SubdomainID > _blk_ids
 
std::vector< SubdomainID > _vec_ids
 
std::vector< SubdomainName > _blocks
 
const bool _blk_dual_restrictable
 
FEProblemBase * _blk_feproblem
 
const MooseMesh * _blk_mesh
 
const std::set< BoundaryID > _empty_boundary_ids
 
const std::set< BoundaryID > & _boundary_ids
 
THREAD_ID _blk_tid
 
const std::string & _blk_name
 
unsigned int _blk_dim
 
Moose::Kokkos::Array< ContiguousElementID > _kokkos_element_ids
 
Moose::Kokkos::Array< ContiguousNodeID > _kokkos_node_ids
 
Moose::Kokkos::Array< Moose::Kokkos::Pair< ContiguousElementID, unsigned int > > _kokkos_element_side_ids
 
const InputParameters & _fi_params
 
const std::string _fi_name
 
SubProblem *const _fi_subproblem
 
const THREAD_ID _fi_tid
 
std::vector< std::unique_ptr< Moose::Functor< Real > > > _default_real_functors
 
std::vector< std::unique_ptr< Moose::Functor< ADReal > > > _default_ad_real_functors
 
std::set< MooseVariableFieldBase * > _moose_variable_dependencies
 
std::vector< libMesh::dof_id_type > _dof_indices
 

Detailed Description

Finite-volume elemental kernel that adds the apparent heat-capacity phase-change source term: rho * L * (df/dT) * T_dot.

Definition at line 12 of file LinearFVPhaseChangeSource.h.

Constructor & Destructor Documentation

◆ LinearFVPhaseChangeSource()

LinearFVPhaseChangeSource::LinearFVPhaseChangeSource ( const InputParameters &  params)

Constructor.

Definition at line 34 of file LinearFVPhaseChangeSource.C.

35 : LinearFVElementalKernel(params),
36 _L(getFunctor<Real>("L")),
37 _rho(getFunctor<Real>(NS::density)),
38 _T_solidus(getFunctor<Real>("T_solidus")),
39 _T_liquidus(getFunctor<Real>("T_liquidus")),
40 _smooth(getParam<MooseEnum>("smoothing") == "smooth"),
41 _time_integrator(_sys.getTimeIntegrator(_var_num)),
42 _factor_history(_time_integrator.numStatesRequired(), 0.0),
43 _state_args(_time_integrator.numStatesRequired(), determineState())
44{
45}
LinearFVElementalKernel::_var_num
const unsigned int _var_num
LinearFVPhaseChangeSource::_state_args
std::vector< Moose::StateArg > _state_args
State args, the args which will help us fetch the different states of the material property multiplie...
Definition LinearFVPhaseChangeSource.h:59
LinearFVPhaseChangeSource::_rho
const Moose::Functor< Real > & _rho
Density.
Definition LinearFVPhaseChangeSource.h:30
LinearFVPhaseChangeSource::_factor_history
std::vector< Real > _factor_history
Current and older values of the material property multiplier.
Definition LinearFVPhaseChangeSource.h:54
LinearFVPhaseChangeSource::_T_solidus
const Moose::Functor< Real > & _T_solidus
Solidus Temperature.
Definition LinearFVPhaseChangeSource.h:33
LinearFVPhaseChangeSource::_T_liquidus
const Moose::Functor< Real > & _T_liquidus
Liquidus Temperature.
Definition LinearFVPhaseChangeSource.h:36
LinearFVPhaseChangeSource::_time_integrator
const TimeIntegrator & _time_integrator
The time integrator to use in this kernel, will provide information on how many states are required i...
Definition LinearFVPhaseChangeSource.h:44
LinearFVPhaseChangeSource::_L
const Moose::Functor< Real > & _L
Latent heat.
Definition LinearFVPhaseChangeSource.h:27
LinearFVPhaseChangeSource::_smooth
const bool _smooth
Whether to use the smoothstep liquid fraction (true, default) or the linear ("sharp") liquid fraction...
Definition LinearFVPhaseChangeSource.h:40
SystemBase::getTimeIntegrator
const TimeIntegrator & getTimeIntegrator(const unsigned int var_num) const
TimeIntegrator::numStatesRequired
virtual unsigned int numStatesRequired() const
LinearFVElementalKernel::determineState
Moose::StateArg determineState() const
NS::density
static const std::string density
Definition NS.h:34

Member Function Documentation

◆ computeDfDT()

Real LinearFVPhaseChangeSource::computeDfDT ( const Real  T,
const Real  T_sol,
const Real  dT_pc 
) const
private

Compute df/dT at temperature T for the selected liquid-fraction shape.

Parameters
TTemperature
T_solSolidus temperature
dT_pcPhase change temperature interval

Definition at line 48 of file LinearFVPhaseChangeSource.C.

49{
50 if (_smooth)
51 {
52 // f(s) = 3 s^2 - 2 s^3 => df/dT = 6 s (1 - s) / dT_pc
53 const Real s = std::clamp((T - T_sol) / dT_pc, 0.0, 1.0);
54 return 6.0 * s * (1.0 - s) / dT_pc;
55 }
56
57 // Sharp: linear liquid fraction, i.e. a top-hat derivative over the open mushy interval
58 if (T > T_sol && T < T_sol + dT_pc)
59 return 1.0 / dT_pc;
60 return 0.0;
61}
T
const double T
Definition GasLiquidMassTransferTest.C:19
libMesh::Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real

Referenced by computeMatrixContribution(), and computeRightHandSideContribution().

◆ computeMatrixContribution()

Real LinearFVPhaseChangeSource::computeMatrixContribution ( )
overridevirtual

Implements LinearFVElementalKernel.

Definition at line 64 of file LinearFVPhaseChangeSource.C.

65{
66 // Element context
67 const auto state = determineState();
68 const auto elem_arg = makeElemArg(_current_elem_info->elem());
69
70 const Real T_sol = _T_solidus(elem_arg, state);
71 const Real T_liq = _T_liquidus(elem_arg, state);
72 const Real dT_pc = T_liq - T_sol;
73
74 // Guard against degenerate or inverted mushy interval
75 if (dT_pc <= 0.0)
76 return 0.0;
77
78 const Real T = _var.getElemValue(*_current_elem_info, state);
79 const Real dfdT = computeDfDT(T, T_sol, dT_pc);
80
81 // Apparent heat capacity term rho * L * (df/dT) * T_dot
82 const Real rhoL = _rho(elem_arg, state) * _L(elem_arg, state);
83 const Real Tdot_coeff = _time_integrator.timeDerivativeMatrixContribution(1.0);
84
85 return rhoL * dfdT * Tdot_coeff * _current_elem_volume;
86}
ElemInfo::elem
const Elem * elem() const
LinearFVElementalKernel::makeElemArg
Moose::ElemArg makeElemArg(const Elem *elem, bool correct_skewnewss=false) const
LinearFVElementalKernel::_current_elem_info
const ElemInfo * _current_elem_info
LinearFVElementalKernel::_var
MooseLinearVariableFV< Real > & _var
LinearFVPhaseChangeSource::computeDfDT
Real computeDfDT(const Real T, const Real T_sol, const Real dT_pc) const
Compute df/dT at temperature T for the selected liquid-fraction shape.
Definition LinearFVPhaseChangeSource.C:48
TimeIntegrator::timeDerivativeMatrixContribution
virtual Real timeDerivativeMatrixContribution(const Real factor) const
MooseLinearVariableFV::getElemValue
Real getElemValue(const ElemInfo &elem_info, const StateArg &state) const

◆ computeRightHandSideContribution()

Real LinearFVPhaseChangeSource::computeRightHandSideContribution ( )
overridevirtual

Implements LinearFVElementalKernel.

Definition at line 89 of file LinearFVPhaseChangeSource.C.

90{
91 // Element context
92 const auto state = determineState();
93 const auto elem_arg = makeElemArg(_current_elem_info->elem());
94
95 const Real T_sol = _T_solidus(elem_arg, state);
96 const Real T_liq = _T_liquidus(elem_arg, state);
97 const Real dT_pc = T_liq - T_sol;
98
99 // Guard against degenerate or inverted mushy interval
100 if (dT_pc <= 0.0)
101 return 0.0;
102
103 const Real T = _var.getElemValue(*_current_elem_info, state);
104 const Real dfdT = computeDfDT(T, T_sol, dT_pc);
105
106 // Apparent heat capacity term rho * L * (df/dT) * T_dot (explicit RHS part)
107 const Real rhoL = _rho(elem_arg, state) * _L(elem_arg, state);
108 const Real Told_dt = _time_integrator.timeDerivativeRHSContribution(_dof_id, _factor_history);
109
110 return rhoL * dfdT * Told_dt * _current_elem_volume;
111}
TimeIntegrator::timeDerivativeRHSContribution
virtual Real timeDerivativeRHSContribution(dof_id_type dof_id, const std::vector< Real > &factors={}) const

◆ setCurrentElemInfo()

void LinearFVPhaseChangeSource::setCurrentElemInfo ( const ElemInfo *  elem_info)
overridevirtual

Reimplemented from LinearFVElementalKernel.

Definition at line 114 of file LinearFVPhaseChangeSource.C.

115{
116 LinearFVElementalKernel::setCurrentElemInfo(elem_info);
117 for (const auto i : index_range(_factor_history))
118 _factor_history[i] = 1.0;
119}
LinearFVElementalKernel::setCurrentElemInfo
virtual void setCurrentElemInfo(const ElemInfo *elem_info)
libMesh::index_range
auto index_range(const T &sizable)

◆ validParams()

InputParameters LinearFVPhaseChangeSource::validParams ( )
static

Definition at line 10 of file LinearFVPhaseChangeSource.C.

11{
12 InputParameters params = LinearFVElementalKernel::validParams();
13
14 params.addClassDescription(
15 "Linear FV elemental kernel that adds the apparent heat-capacity "
16 "phase-change source term: rho * L * (df/dT) * T_dot, with f the liquid "
17 "fraction.");
18
19 params.addRequiredParam<MooseFunctorName>("L", "Latent heat.");
20 params.addRequiredParam<MooseFunctorName>(NS::density, "The mixture density.");
21 params.addRequiredParam<MooseFunctorName>("T_solidus", "The solidus temperature.");
22 params.addRequiredParam<MooseFunctorName>("T_liquidus", "The liquidus temperature.");
23
24 MooseEnum smoothing("smooth sharp", "smooth");
25 params.addParam<MooseEnum>(
26 "smoothing",
27 smoothing,
28 "Shape of the liquid fraction over the mushy interval. 'smooth' (default) uses a "
29 "smoothstep cubic function and 'sharp' uses a linear liquid fraction.");
30
31 return params;
32}
InputParameters::addRequiredParam
void addRequiredParam(const std::string &name, const std::string &doc_string)
InputParameters::addParam
void addParam(const std::string &name, const std::initializer_list< typename T::value_type > &value, const std::string &doc_string)
InputParameters::addClassDescription
void addClassDescription(const std::string &doc_string)
LinearFVElementalKernel::validParams
static InputParameters validParams()

Member Data Documentation

◆ _factor_history

std::vector<Real> LinearFVPhaseChangeSource::_factor_history
private

Current and older values of the material property multiplier.

Definition at line 54 of file LinearFVPhaseChangeSource.h.

Referenced by computeRightHandSideContribution(), and setCurrentElemInfo().

◆ _L

const Moose::Functor<Real>& LinearFVPhaseChangeSource::_L
protected

Latent heat.

Definition at line 27 of file LinearFVPhaseChangeSource.h.

Referenced by computeMatrixContribution(), and computeRightHandSideContribution().

◆ _rho

const Moose::Functor<Real>& LinearFVPhaseChangeSource::_rho
protected

Density.

Definition at line 30 of file LinearFVPhaseChangeSource.h.

Referenced by computeMatrixContribution(), and computeRightHandSideContribution().

◆ _smooth

const bool LinearFVPhaseChangeSource::_smooth
protected

Whether to use the smoothstep liquid fraction (true, default) or the linear ("sharp") liquid fraction (false)

Definition at line 40 of file LinearFVPhaseChangeSource.h.

Referenced by computeDfDT().

◆ _state_args

std::vector<Moose::StateArg> LinearFVPhaseChangeSource::_state_args
private

State args, the args which will help us fetch the different states of the material property multiplier.

0th is the current, 1st is old 2nd is the older. Might not need all, depends on the time integrator.

Definition at line 59 of file LinearFVPhaseChangeSource.h.

◆ _T_liquidus

const Moose::Functor<Real>& LinearFVPhaseChangeSource::_T_liquidus
protected

Liquidus Temperature.

Definition at line 36 of file LinearFVPhaseChangeSource.h.

Referenced by computeMatrixContribution(), and computeRightHandSideContribution().

◆ _T_solidus

const Moose::Functor<Real>& LinearFVPhaseChangeSource::_T_solidus
protected

Solidus Temperature.

Definition at line 33 of file LinearFVPhaseChangeSource.h.

Referenced by computeMatrixContribution(), and computeRightHandSideContribution().

◆ _time_integrator

const TimeIntegrator& LinearFVPhaseChangeSource::_time_integrator
protected

The time integrator to use in this kernel, will provide information on how many states are required in the history.

Definition at line 44 of file LinearFVPhaseChangeSource.h.

Referenced by computeMatrixContribution(), and computeRightHandSideContribution().

The documentation for this class was generated from the following files:
Generated on Fri Sep 11 2026 20:38:40 for https://mooseframework.inl.gov by doxygen 1.9.8