Interface for a type of functions using coefficients that may be changed before or after a solve.
More...
|
| MutableCoefficientsFunctionInterface (const MooseObject *moose_object, const InputParameters ¶meters) |
|
virtual void | meshChanged () override |
|
void | useCache (bool use) |
| Enable/disable the cache. More...
|
|
virtual Real | value (Real time, const Point &point) const final |
|
virtual ADReal | value (const ADReal &time, const ADPoint &point) const final |
|
virtual Real | value (Real t, const Point &p) const |
|
virtual ADReal | value (const ADReal &t, const ADPoint &p) const |
|
ChainedReal | value (const ChainedReal &t) const |
|
auto | value (const U &t) const |
|
auto | value (const U &t, const U &x, const U &y=0, const U &z=0) const |
|
ChainedReal | value (const ChainedReal &t) const |
|
auto | value (const U &t) const |
|
auto | value (const U &t, const U &x, const U &y=0, const U &z=0) const |
|
ChainedReal | value (const ChainedReal &t) const |
|
auto | value (const U &t) const |
|
auto | value (const U &t, const U &x, const U &y=0, const U &z=0) const |
|
virtual RealVectorValue | vectorValue (Real t, const Point &p) const |
|
virtual RealVectorValue | curl (Real t, const Point &p) const |
|
virtual Real | div (Real t, const Point &p) const |
|
virtual RealGradient | gradient (Real t, const Point &p) const |
|
GradientType | gradient (const ElemArg &elem, const StateArg &state) const |
|
GradientType | gradient (const FaceArg &face, const StateArg &state) const |
|
GradientType | gradient (const ElemQpArg &qp, const StateArg &state) const |
|
GradientType | gradient (const ElemSideQpArg &qp, const StateArg &state) const |
|
GradientType | gradient (const ElemPointArg &elem_point, const StateArg &state) const |
|
GradientType | gradient (const NodeArg &node, const StateArg &state) const |
|
GradientType | gradient (const ElemArg &elem, const StateArg &state) const |
|
GradientType | gradient (const FaceArg &face, const StateArg &state) const |
|
GradientType | gradient (const ElemQpArg &qp, const StateArg &state) const |
|
GradientType | gradient (const ElemSideQpArg &qp, const StateArg &state) const |
|
GradientType | gradient (const ElemPointArg &elem_point, const StateArg &state) const |
|
GradientType | gradient (const NodeArg &node, const StateArg &state) const |
|
GradientType | gradient (const ElemArg &elem, const StateArg &state) const |
|
GradientType | gradient (const FaceArg &face, const StateArg &state) const |
|
GradientType | gradient (const ElemQpArg &qp, const StateArg &state) const |
|
GradientType | gradient (const ElemSideQpArg &qp, const StateArg &state) const |
|
GradientType | gradient (const ElemPointArg &elem_point, const StateArg &state) const |
|
GradientType | gradient (const NodeArg &node, const StateArg &state) const |
|
virtual Real | timeDerivative (Real t, const Point &p) const |
|
auto | timeDerivative (const U &t) const |
|
auto | timeDerivative (const U &t, const U &x, const U &y=0, const U &z=0) const |
|
auto | timeDerivative (const U &t) const |
|
auto | timeDerivative (const U &t, const U &x, const U &y=0, const U &z=0) const |
|
virtual Real | integral () const |
|
virtual Real | average () const |
|
void | timestepSetup () override |
|
void | residualSetup () override |
|
void | jacobianSetup () override |
|
void | customSetup (const ExecFlagType &exec_type) override |
|
bool | hasBlocks (SubdomainID) const override |
|
bool | supportsFaceArg () const override final |
|
bool | supportsElemSideQpArg () const override final |
|
virtual bool | enabled () 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 ¶meter_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 ¶m1, const std::string ¶m2) 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 ¶m, Args... args) const |
|
void | paramWarning (const std::string ¶m, Args... args) const |
|
void | paramInfo (const std::string ¶m, Args... args) const |
|
void | connectControllableParams (const std::string ¶meter, 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 | 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 ¶m) const |
|
std::string | getDataFileNameByName (const std::string &name, const std::string *param=nullptr) const |
|
virtual void | initialSetup () |
|
virtual void | subdomainSetup () |
|
const ExecFlagEnum & | getExecuteOnEnum () const |
|
bool | isImplicit () |
|
bool | isDefaultPostprocessorValue (const std::string ¶m_name, const unsigned int index=0) const |
|
bool | hasPostprocessor (const std::string ¶m_name, const unsigned int index=0) const |
|
bool | hasPostprocessorByName (const PostprocessorName &name) const |
|
std::size_t | coupledPostprocessors (const std::string ¶m_name) const |
|
const PostprocessorName & | getPostprocessorName (const std::string ¶m_name, const unsigned int index=0) const |
|
UserObjectName | getUserObjectName (const std::string ¶m_name) const |
|
const T & | getUserObject (const std::string ¶m_name, bool is_dependency=true) const |
|
const T & | getUserObjectByName (const UserObjectName &object_name, bool is_dependency=true) const |
|
const UserObject & | getUserObjectBase (const std::string ¶m_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 |
|
FunctorReturnType< Real, FET >::type | genericEvaluate (const Space &r, const State &state) const |
|
const MooseFunctorName & | functorName () const |
|
void | setCacheClearanceSchedule (const std::set< ExecFlagType > &clearance_schedule) |
|
virtual bool | isExtrapolatedBoundaryFace (const FaceInfo &, const Elem *, const StateArg &) const |
|
bool | isInternalFace (const FaceInfo &) const |
|
virtual bool | isConstant () const |
|
virtual bool | hasFaceSide (const FaceInfo &fi, const bool fi_elem_side) const override |
|
Moose::FaceArg | checkFace (const Moose::FaceArg &face) const |
|
const PostprocessorValue & | getPostprocessorValue (const std::string ¶m_name, const unsigned int index=0) const |
|
const PostprocessorValue & | getPostprocessorValue (const std::string ¶m_name, const unsigned int index=0) const |
|
const PostprocessorValue & | getPostprocessorValueOld (const std::string ¶m_name, const unsigned int index=0) const |
|
const PostprocessorValue & | getPostprocessorValueOld (const std::string ¶m_name, const unsigned int index=0) const |
|
const PostprocessorValue & | getPostprocessorValueOlder (const std::string ¶m_name, const unsigned int index=0) const |
|
const PostprocessorValue & | getPostprocessorValueOlder (const std::string ¶m_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 | hasUserObject (const std::string ¶m_name) const |
|
bool | hasUserObject (const std::string ¶m_name) const |
|
bool | hasUserObject (const std::string ¶m_name) const |
|
bool | hasUserObject (const std::string ¶m_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 |
|
ValueType | operator() (const ElemArg &elem, const StateArg &state) const |
|
ValueType | operator() (const FaceArg &face, const StateArg &state) const |
|
ValueType | operator() (const ElemQpArg &qp, const StateArg &state) const |
|
ValueType | operator() (const ElemSideQpArg &qp, const StateArg &state) const |
|
ValueType | operator() (const ElemPointArg &elem_point, const StateArg &state) const |
|
ValueType | operator() (const NodeArg &node, const StateArg &state) const |
|
ValueType | operator() (const ElemArg &elem, const StateArg &state) const |
|
ValueType | operator() (const FaceArg &face, const StateArg &state) const |
|
ValueType | operator() (const ElemQpArg &qp, const StateArg &state) const |
|
ValueType | operator() (const ElemSideQpArg &qp, const StateArg &state) const |
|
ValueType | operator() (const ElemPointArg &elem_point, const StateArg &state) const |
|
ValueType | operator() (const NodeArg &node, const StateArg &state) const |
|
ValueType | operator() (const ElemArg &elem, const StateArg &state) const |
|
ValueType | operator() (const FaceArg &face, const StateArg &state) const |
|
ValueType | operator() (const ElemQpArg &qp, const StateArg &state) const |
|
ValueType | operator() (const ElemSideQpArg &qp, const StateArg &state) const |
|
ValueType | operator() (const ElemPointArg &elem_point, const StateArg &state) const |
|
ValueType | operator() (const NodeArg &node, const StateArg &state) const |
|
DotType | dot (const ElemArg &elem, const StateArg &state) const |
|
DotType | dot (const FaceArg &face, const StateArg &state) const |
|
DotType | dot (const ElemQpArg &qp, const StateArg &state) const |
|
DotType | dot (const ElemSideQpArg &qp, const StateArg &state) const |
|
DotType | dot (const ElemPointArg &elem_point, const StateArg &state) const |
|
DotType | dot (const NodeArg &node, const StateArg &state) const |
|
DotType | dot (const ElemArg &elem, const StateArg &state) const |
|
DotType | dot (const FaceArg &face, const StateArg &state) const |
|
DotType | dot (const ElemQpArg &qp, const StateArg &state) const |
|
DotType | dot (const ElemSideQpArg &qp, const StateArg &state) const |
|
DotType | dot (const ElemPointArg &elem_point, const StateArg &state) const |
|
DotType | dot (const NodeArg &node, const StateArg &state) const |
|
DotType | dot (const ElemArg &elem, const StateArg &state) const |
|
DotType | dot (const FaceArg &face, const StateArg &state) const |
|
DotType | dot (const ElemQpArg &qp, const StateArg &state) const |
|
DotType | dot (const ElemSideQpArg &qp, const StateArg &state) const |
|
DotType | dot (const ElemPointArg &elem_point, const StateArg &state) const |
|
DotType | dot (const NodeArg &node, const StateArg &state) const |
|
GradientType | gradDot (const ElemArg &elem, const StateArg &state) const |
|
GradientType | gradDot (const FaceArg &face, const StateArg &state) const |
|
GradientType | gradDot (const ElemQpArg &qp, const StateArg &state) const |
|
GradientType | gradDot (const ElemSideQpArg &qp, const StateArg &state) const |
|
GradientType | gradDot (const ElemPointArg &elem_point, const StateArg &state) const |
|
GradientType | gradDot (const NodeArg &node, const StateArg &state) const |
|
GradientType | gradDot (const ElemArg &elem, const StateArg &state) const |
|
GradientType | gradDot (const FaceArg &face, const StateArg &state) const |
|
GradientType | gradDot (const ElemQpArg &qp, const StateArg &state) const |
|
GradientType | gradDot (const ElemSideQpArg &qp, const StateArg &state) const |
|
GradientType | gradDot (const ElemPointArg &elem_point, const StateArg &state) const |
|
GradientType | gradDot (const NodeArg &node, const StateArg &state) const |
|
GradientType | gradDot (const ElemArg &elem, const StateArg &state) const |
|
GradientType | gradDot (const FaceArg &face, const StateArg &state) const |
|
GradientType | gradDot (const ElemQpArg &qp, const StateArg &state) const |
|
GradientType | gradDot (const ElemSideQpArg &qp, const StateArg &state) const |
|
GradientType | gradDot (const ElemPointArg &elem_point, const StateArg &state) const |
|
GradientType | gradDot (const NodeArg &node, const StateArg &state) const |
|
const Parallel::Communicator & | comm () const |
|
processor_id_type | n_processors () const |
|
processor_id_type | processor_id () const |
|
Real | operator[] (std::size_t index) const |
| Get the value of the coefficient at the corresponding index. More...
|
|
const std::vector< std::size_t > & | getCharacteristics () const |
| Get a reference to the characteristics array. More...
|
|
const std::vector< Real > & | getCoefficients () const |
| Get a read-only reference to the vector of coefficients. More...
|
|
std::vector< Real > & | getCoefficients () |
| Get a writeable reference to the vector of coefficients. More...
|
|
std::string | getCoefficientsTable () const |
| Get a formatted string of the coefficients. More...
|
|
std::size_t | getSize () const |
| Get the size, aka number of coefficients. More...
|
|
bool | isCompatibleWith (const MutableCoefficientsInterface &other) const |
| Checks to see if another instance is compatible. More...
|
|
bool | isSizeEnforced () const |
| Returns true if the size of the coefficient array is fixed and enforced. More...
|
|
void | enforceSize (bool enforce) |
| Toggle whether the size of the coefficient array can be changed. More...
|
|
void | importCoefficients (const MutableCoefficientsInterface &other) |
| Import the coefficients from another instance. More...
|
|
void | resize (std::size_t size, Real fill=0.0, bool fill_out_to_size=true) |
| Resize the array, using the value for fill if the new size is larger. More...
|
|
void | setCharacteristics (const std::vector< std::size_t > &new_characteristics) |
| Sets the characteristics array. More...
|
|
void | setCoefficients (const std::vector< Real > &new_coefficients) |
| Set the coefficients using a copy operation. More...
|
|
void | setCoefficients (std::vector< Real > &&dropin_coefficients) |
| Set the coefficients using a move operation (only works with temp objects) More...
|
|
|
virtual void | coefficientsChanged () override |
| Called when the coefficients have been changed. More...
|
|
virtual Real | evaluateValue (Real time, const Point &point)=0 |
| Used in derived classes, equivalent to Function::value() More...
|
|
void | invalidateCache () |
| Called by derived classes to invalidate the cache, perhaps due to a state change. More...
|
|
Moose::StateArg | determineState () const |
|
virtual void | addPostprocessorDependencyHelper (const PostprocessorName &) const |
|
virtual void | addUserObjectDependencyHelper (const UserObject &) 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 |
|
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 |
|
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 GradientType | evaluateGradDot (const ElemArg &, const StateArg &) const |
|
virtual GradientType | evaluateGradDot (const FaceArg &, const StateArg &) const |
|
virtual GradientType | evaluateGradDot (const ElemQpArg &, const StateArg &) const |
|
virtual GradientType | evaluateGradDot (const ElemSideQpArg &, const StateArg &) const |
|
virtual GradientType | evaluateGradDot (const ElemPointArg &, const StateArg &) const |
|
virtual GradientType | evaluateGradDot (const NodeArg &, const StateArg &) const |
|
virtual GradientType | evaluateGradDot (const ElemArg &, const StateArg &) const |
|
virtual GradientType | evaluateGradDot (const FaceArg &, const StateArg &) const |
|
virtual GradientType | evaluateGradDot (const ElemQpArg &, const StateArg &) const |
|
virtual GradientType | evaluateGradDot (const ElemSideQpArg &, const StateArg &) const |
|
virtual GradientType | evaluateGradDot (const ElemPointArg &, const StateArg &) const |
|
virtual GradientType | evaluateGradDot (const NodeArg &, const StateArg &) const |
|
virtual GradientType | evaluateGradDot (const ElemArg &, const StateArg &) const |
|
virtual GradientType | evaluateGradDot (const FaceArg &, const StateArg &) const |
|
virtual GradientType | evaluateGradDot (const ElemQpArg &, const StateArg &) const |
|
virtual GradientType | evaluateGradDot (const ElemSideQpArg &, const StateArg &) const |
|
virtual GradientType | evaluateGradDot (const ElemPointArg &, const StateArg &) const |
|
virtual GradientType | evaluateGradDot (const NodeArg &, const StateArg &) const |
|
virtual ValueType | evaluate (const ElemArg &elem, const StateArg &state) const =0 |
|
virtual ValueType | evaluate (const FaceArg &face, const StateArg &state) const =0 |
|
virtual ValueType | evaluate (const ElemQpArg &qp, const StateArg &state) const =0 |
|
virtual ValueType | evaluate (const ElemSideQpArg &side_qp, const StateArg &state) const =0 |
|
virtual ValueType | evaluate (const ElemPointArg &elem_point, const StateArg &state) const =0 |
|
virtual ValueType | evaluate (const NodeArg &node, const StateArg &state) const =0 |
|
virtual GradientType | evaluateGradient (const ElemArg &, const StateArg &) const |
|
virtual GradientType | evaluateGradient (const FaceArg &, const StateArg &) const |
|
virtual GradientType | evaluateGradient (const ElemQpArg &, const StateArg &) const |
|
virtual GradientType | evaluateGradient (const ElemSideQpArg &, const StateArg &) const |
|
virtual GradientType | evaluateGradient (const ElemPointArg &, const StateArg &) const |
|
virtual GradientType | evaluateGradient (const NodeArg &, const StateArg &) const |
|
virtual DotType | evaluateDot (const ElemArg &, const StateArg &) const |
|
virtual DotType | evaluateDot (const FaceArg &, const StateArg &) const |
|
virtual DotType | evaluateDot (const ElemQpArg &, const StateArg &) const |
|
virtual DotType | evaluateDot (const ElemSideQpArg &, const StateArg &) const |
|
virtual DotType | evaluateDot (const ElemPointArg &, const StateArg &) const |
|
virtual DotType | evaluateDot (const NodeArg &, const StateArg &) const |
|
const Function & | getFunction (const std::string &name) const |
|
const Function & | getFunctionByName (const FunctionName &name) const |
|
bool | hasFunction (const std::string ¶m_name) const |
|
bool | hasFunctionByName (const FunctionName &name) const |
|