#include <FunctionScalarIC.h>

Inheritance diagram for FunctionScalarIC:

Public Member Functions
	FunctionScalarIC (const InputParameters &parameters)

MooseVariableScalar &	variable ()

virtual void	compute (DenseVector< Number > &vals)
	Compute the initial condition. More...

virtual void	initialSetup ()
	Gets called at the beginning of the simulation before this object is asked to do its job. More...

virtual const std::set< std::string > &	getRequestedItems ()
	Return a set containing the names of items requested by the object. More...

virtual const std::set< std::string > &	getSuppliedItems ()
	Return a set containing the names of items owned by the object. More...

const std::string &	type () const
	Get the type of this object. More...

virtual const std::string &	name () const
	Get the name of the object. More...

const InputParameters &	parameters () const
	Get the parameters of the object. More...

template<typename T >
const T &	getParamTempl (const std::string &name) const
	Retrieve a parameter for the object. More...

template<typename T >
T	getCheckedPointerParam (const std::string &name, const std::string &error_string="") const
	Verifies that the requested parameter exists and is not NULL and returns it to the caller. More...

bool	isParamValid (const std::string &name) const
	Test if the supplied parameter is valid. More...

MooseApp &	getMooseApp () const
	Get the MooseApp this object is associated with. More...

virtual bool	enabled () const
	Return the enabled status of the object. More...

template<typename... Args>
void	paramError (const std::string &param, Args... args) const
	Emits an error prefixed with the file and line number of the given param (from the input file) along with the full parameter path+name followed by the given args as the message. More...

template<typename... Args>
void	paramWarning (const std::string &param, Args... args) const
	Emits a warning prefixed with the file and line number of the given param (from the input file) along with the full parameter path+name followed by the given args as the message. More...

template<typename... Args>
void	paramInfo (const std::string &param, Args... args) const
	Emits an informational message prefixed with the file and line number of the given param (from the input file) along with the full parameter path+name followed by the given args as the message. More...

template<typename... Args>
void	mooseError (Args &&... args) const

template<typename... Args>
void	mooseWarning (Args &&... args) const

template<typename... Args>
void	mooseDeprecated (Args &&... args) const

template<typename... Args>
void	mooseInfo (Args &&... args) const

const std::vector< MooseVariableScalar * > &	getCoupledMooseScalarVars ()
	Get the list of coupled scalar variables. More...

std::set< TagID > &	getScalarVariableCoupleableVectorTags ()

std::set< TagID > &	getScalarVariableCoupleableMatrixTags ()

void	addScalarVariableCoupleableVectorTag (TagID tag)

void	addScalarVariableCoupleableMatrixTag (TagID tag)

const Function &	getFunction (const std::string &name) const
	Get a function with a given name. More...

const Function &	getFunctionByName (const FunctionName &name) const
	Get a function with a given name. More...

template<class T >
const T &	getUserObjectTempl (const std::string &name)
	Get an user object with a given parameter name. More...

template<class T >
const T &	getUserObjectByNameTempl (const std::string &name)
	Get an user object with a given name. More...

const UserObject &	getUserObjectBase (const std::string &name)
	Get an user object with a given parameter name. More...

const UserObject &	getUserObjectBaseByName (const std::string &name)
	Get an user object with a given name. More...

Static Public Member Functions
static InputParameters	validParams ()

template<typename T >
static void	sort (typename std::vector< T > &vector)
	Given a vector, sort using the getRequested/SuppliedItems sets. More...

template<typename T >
static void	cyclicDependencyError (CyclicDependencyException< T > &e, const std::string &header)
	A helper method for cyclic errors. More...

Public Attributes
const ConsoleStream	_console
	An instance of helper class to write streams to the Console objects. More...

Protected Member Functions
virtual Real	value () override
	The value of the variable. More...

virtual bool	isCoupledScalar (const std::string &var_name, unsigned int i=0)
	Returns true if a variables has been coupled_as name. More...

virtual unsigned int	coupledScalarComponents (const std::string &var_name)
	Return the number of components to the coupled scalar variable. More...

virtual unsigned int	coupledScalar (const std::string &var_name, unsigned int comp=0)
	Returns the index for a scalar coupled variable by name. More...

virtual Order	coupledScalarOrder (const std::string &var_name, unsigned int comp=0)
	Returns the order for a scalar coupled variable by name. More...

virtual VariableValue &	coupledScalarValue (const std::string &var_name, unsigned int comp=0)
	Returns value of a scalar coupled variable. More...

template<ComputeStage compute_stage>
const ADVariableValue &	adCoupledScalarValueTempl (const std::string &var_name, unsigned int comp=0)
	Returns AD value of a scalar coupled variable. More...

virtual VariableValue &	coupledVectorTagScalarValue (const std::string &var_name, TagID tag, unsigned int comp=0)
	Returns value of a scalar coupled variable. More...

virtual VariableValue &	coupledMatrixTagScalarValue (const std::string &var_name, TagID tag, unsigned int comp=0)
	Returns value of a scalar coupled variable. More...

virtual VariableValue &	coupledScalarValueOld (const std::string &var_name, unsigned int comp=0)
	Returns the old (previous time step) value of a scalar coupled variable. More...

virtual VariableValue &	coupledScalarValueOlder (const std::string &var_name, unsigned int comp=0)
	Returns the older (two time steps previous) value of a scalar coupled variable. More...

virtual VariableValue &	coupledScalarDot (const std::string &var_name, unsigned int comp=0)
	Returns the time derivative of a scalar coupled variable. More...

virtual VariableValue &	coupledScalarDotDot (const std::string &var_name, unsigned int comp=0)
	Returns the second time derivative of a scalar coupled variable. More...

virtual VariableValue &	coupledScalarDotOld (const std::string &var_name, unsigned int comp=0)
	Returns the old time derivative of a scalar coupled variable. More...

virtual VariableValue &	coupledScalarDotDotOld (const std::string &var_name, unsigned int comp=0)
	Returns the old second time derivative of a scalar coupled variable. More...

virtual VariableValue &	coupledScalarDotDu (const std::string &var_name, unsigned int comp=0)
	Time derivative of a scalar coupled variable with respect to the coefficients. More...

virtual VariableValue &	coupledScalarDotDotDu (const std::string &var_name, unsigned int comp=0)
	Second time derivative of a scalar coupled variable with respect to the coefficients. More...

VariableValue *	getDefaultValue (const std::string &var_name)
	Helper method to return (and insert if necessary) the default value for an uncoupled variable. More...

template<ComputeStage compute_stage>
ADVariableValue *	getADDefaultValue (const std::string &var_name)
	Helper method to return (and insert if necessary) the AD default value for an uncoupled variable. More...

void	checkVar (const std::string &var_name)
	Check that the right kind of variable is being coupled in. More...

MooseVariableScalar *	getScalarVar (const std::string &var_name, unsigned int comp)
	Extract pointer to a scalar coupled variable. More...

void	validateExecutionerType (const std::string &name, const std::string &fn_name) const
	Checks to make sure that the current Executioner has set "_is_transient" when old/older values are coupled in. More...

Protected Attributes
unsigned int	_ncomp

std::vector< const Function * >	_func

FEProblemBase &	_fe_problem

SystemBase &	_sys

THREAD_ID	_tid

Assembly &	_assembly

Real &	_t
	Time. More...

MooseVariableScalar &	_var
	Scalar variable this initial condition works on. More...

unsigned int	_i

std::set< std::string >	_depend_vars

std::set< std::string >	_supplied_vars

const InputParameters &	_pars
	Parameters of this object, references the InputParameters stored in the InputParametersWarehouse. More...

MooseApp &	_app
	The MooseApp this object is associated with. More...

const std::string &	_type
	The type of this object (the Class name) More...

const std::string &	_name
	The name of this object, reference to value stored in InputParameters. More...

const bool &	_enabled
	Reference to the "enable" InputParaemters, used by Controls for toggling on/off MooseObjects. More...

const InputParameters &	_sc_parameters

const std::string &	_sc_name
	The name of the object this interface is part of. More...

FEProblemBase &	_sc_fe_problem

std::unordered_map< std::string, std::vector< MooseVariableScalar * > >	_coupled_scalar_vars
	Coupled vars whose values we provide. More...

std::unordered_map< std::string, std::unique_ptr< VariableValue > >	_default_value
	Will hold the default value for optional coupled scalar variables. More...

std::unordered_map< std::string, std::unique_ptr< DualVariableValue > >	_dual_default_value
	Will hold the default AD value for optional coupled scalar variables. More...

std::vector< MooseVariableScalar * >	_coupled_moose_scalar_vars
	Vector of coupled variables. More...

bool	_sc_is_implicit
	True if implicit value is required. More...

const InputParameters &	_coupleable_params
	Local InputParameters. More...

THREAD_ID	_sc_tid
	Thread ID of the thread using this object. More...

const Real &	_real_zero
	Scalar zero. More...

const VariableValue &	_scalar_zero
	Zero value of a scalar variable. More...

const Point &	_point_zero
	Zero point. More...

Private Member Functions
template<typename... Args>
std::string	paramErrorMsg (const std::string &param, Args... args) const

bool	needThreadedCopy (const UserObject &uo) const
	Check if the threaded copy of the user object is needed. More...

Private Attributes
std::unordered_map< std::string, std::vector< MooseVariableFEBase * > >	_sc_coupled_vars
	Field variables coupled into this object (for error checking) More...

std::set< TagID >	_sc_coupleable_vector_tags

std::set< TagID >	_sc_coupleable_matrix_tags

const InputParameters &	_fni_params
	Parameters of the object with this interface. More...

FEProblemBase &	_fni_feproblem
	Reference to FEProblemBase instance. More...

const THREAD_ID	_fni_tid
	Thread ID. More...

const InputParameters &	_uoi_params
	Parameters of the object with this interface. More...

FEProblemBase &	_uoi_feproblem
	Reference to the FEProblemBase instance. More...

THREAD_ID	_uoi_tid
	Thread ID. More...

Detailed Description

Definition at line 21 of file FunctionScalarIC.h.

Constructor & Destructor Documentation

◆ FunctionScalarIC()

FunctionScalarIC::FunctionScalarIC ( const InputParameters & parameters )

Definition at line 28 of file FunctionScalarIC.C.

   : ScalarInitialCondition(parameters), _ncomp(_var.order())
 {
   std::vector<FunctionName> funcs = getParam<std::vector<FunctionName>>("function");
   if (funcs.size() != _ncomp)
     mooseError("number of functions must be equal to the scalar variable order");
  
   for (const auto & func_name : funcs)
     _func.push_back(&getFunctionByName(func_name));
 }

Member Function Documentation

◆ adCoupledScalarValueTempl()

template<ComputeStage compute_stage>

const ADVariableValue & ScalarCoupleable::adCoupledScalarValueTempl	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)

protectedinherited

Returns AD value of a scalar coupled variable.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Reference to a ADVariableValue for the coupled variable

Definition at line 138 of file ScalarCoupleable.C.

 {
   checkVar(var_name);
   if (!isCoupledScalar(var_name, comp))
     return *getADDefaultValue<compute_stage>(var_name);
  
   MooseVariableScalar * var = getScalarVar(var_name, comp);
  
   if (_sc_is_implicit)
     return var->adSln<compute_stage>();
   else
     mooseError("adCoupledValue for non-implicit calculations is not currently supported. Use "
                "coupledValue instead for non-implicit");
 }

◆ addScalarVariableCoupleableMatrixTag()

void ScalarCoupleable::addScalarVariableCoupleableMatrixTag ( TagID tag )

inlineinherited

Definition at line 55 of file ScalarCoupleable.h.

55 { _sc_coupleable_matrix_tags.insert(tag); }

Referenced by ScalarCoupleable::coupledMatrixTagScalarValue().

◆ addScalarVariableCoupleableVectorTag()

void ScalarCoupleable::addScalarVariableCoupleableVectorTag ( TagID tag )

inlineinherited

Definition at line 53 of file ScalarCoupleable.h.

53 { _sc_coupleable_vector_tags.insert(tag); }

Referenced by ScalarCoupleable::coupledVectorTagScalarValue().

◆ checkVar()

void ScalarCoupleable::checkVar ( const std::string & var_name )

protectedinherited

Check that the right kind of variable is being coupled in.

Parameters

var_name The name of the coupled variable

Definition at line 294 of file ScalarCoupleable.C.

 {
   auto it = _sc_coupled_vars.find(var_name);
   if (it != _sc_coupled_vars.end())
   {
     std::string cvars;
     for (auto jt : it->second)
       cvars += " " + jt->name();
     mooseError(_sc_name,
                ": Trying to couple a field variable where scalar variable is expected, '",
                var_name,
                " =",
                cvars,
                "'");
   }
   // NOTE: non-existent variables are handled in the constructor
 }

◆ compute()

void ScalarInitialCondition::compute ( DenseVector< Number > & vals )

virtualinherited

Compute the initial condition.

Definition at line 64 of file ScalarInitialCondition.C.

 {
   for (_i = 0; _i < _var.order(); ++_i)
     vals(_i) = value();
 }

◆ coupledMatrixTagScalarValue()

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

protectedvirtualinherited

Returns value of a scalar coupled variable.

Parameters

var_name	Name of coupled variable
tag	Tag ID of coupled matrix;
comp	Component number for vector of coupled variables

Returns: Reference to a VariableValue for the coupled variable

Definition at line 199 of file ScalarCoupleable.C.

 {
   checkVar(var_name);
   if (!isCoupledScalar(var_name, comp))
     return *getDefaultValue(var_name);
  
   addScalarVariableCoupleableMatrixTag(tag);
  
   MooseVariableScalar * var = getScalarVar(var_name, comp);
   return var->matrixTagSln(tag);
 }

◆ coupledScalar()

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

protectedvirtualinherited

Returns the index for a scalar coupled variable by name.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Index of coupled variable

Definition at line 95 of file ScalarCoupleable.C.

 {
   checkVar(var_name);
   return getScalarVar(var_name, comp)->number();
 }

Referenced by ParsedODEKernel::ParsedODEKernel().

◆ coupledScalarComponents()

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

protectedvirtualinherited

Return the number of components to the coupled scalar variable.

Parameters

var_name The of the coupled variable

Definition at line 341 of file ScalarCoupleable.C.

 {
   return _coupled_scalar_vars[var_name].size();
 }

◆ coupledScalarDot()

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

protectedvirtualinherited

Returns the time derivative of a scalar coupled variable.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Reference to a time derivative VariableValue for the coupled variable

Definition at line 241 of file ScalarCoupleable.C.

 {
   checkVar(var_name);
   validateExecutionerType(var_name, "coupledScalarDot");
   MooseVariableScalar * var = getScalarVar(var_name, comp);
   return var->uDot();
 }

◆ coupledScalarDotDot()

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

protectedvirtualinherited

Returns the second time derivative of a scalar coupled variable.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Reference to a time derivative VariableValue for the coupled variable

Definition at line 250 of file ScalarCoupleable.C.

 {
   checkVar(var_name);
   validateExecutionerType(var_name, "coupledScalarDotDot");
   MooseVariableScalar * var = getScalarVar(var_name, comp);
   return var->uDotDot();
 }

◆ coupledScalarDotDotDu()

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

protectedvirtualinherited

Second time derivative of a scalar coupled variable with respect to the coefficients.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Reference to a VariableValue containing the time derivative of the coupled variable with respect to the coefficients

Definition at line 285 of file ScalarCoupleable.C.

 {
   checkVar(var_name);
   validateExecutionerType(var_name, "coupledScalarDotDotDu");
   MooseVariableScalar * var = getScalarVar(var_name, comp);
   return var->duDotDotDu();
 }

◆ coupledScalarDotDotOld()

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

protectedvirtualinherited

Returns the old second time derivative of a scalar coupled variable.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Reference to a time derivative VariableValue for the coupled variable

Definition at line 268 of file ScalarCoupleable.C.

 {
   checkVar(var_name);
   validateExecutionerType(var_name, "coupledScalarDotDotOld");
   MooseVariableScalar * var = getScalarVar(var_name, comp);
   return var->uDotDotOld();
 }

◆ coupledScalarDotDu()

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

protectedvirtualinherited

Time derivative of a scalar coupled variable with respect to the coefficients.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Reference to a VariableValue containing the time derivative of the coupled variable with respect to the coefficients

Definition at line 276 of file ScalarCoupleable.C.

 {
   checkVar(var_name);
   validateExecutionerType(var_name, "coupledScalarDotDu");
   MooseVariableScalar * var = getScalarVar(var_name, comp);
   return var->duDotDu();
 }

◆ coupledScalarDotOld()

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

protectedvirtualinherited

Returns the old time derivative of a scalar coupled variable.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Reference to a time derivative VariableValue for the coupled variable

Definition at line 259 of file ScalarCoupleable.C.

 {
   checkVar(var_name);
   validateExecutionerType(var_name, "coupledScalarDotOld");
   MooseVariableScalar * var = getScalarVar(var_name, comp);
   return var->uDotOld();
 }

◆ coupledScalarOrder()

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

protectedvirtualinherited

Returns the order for a scalar coupled variable by name.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Order of coupled variable

Definition at line 102 of file ScalarCoupleable.C.

 {
   checkVar(var_name);
   if (!isCoupledScalar(var_name, comp))
     return _sc_fe_problem.getMaxScalarOrder();
  
   return getScalarVar(var_name, comp)->order();
 }

◆ coupledScalarValue()

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

protectedvirtualinherited

Returns value of a scalar coupled variable.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Reference to a VariableValue for the coupled variable

Definition at line 126 of file ScalarCoupleable.C.

 {
   checkVar(var_name);
   if (!isCoupledScalar(var_name, comp))
     return *getDefaultValue(var_name);
  
   MooseVariableScalar * var = getScalarVar(var_name, comp);
   return (_sc_is_implicit) ? var->sln() : var->slnOld();
 }

Referenced by ParsedODEKernel::ParsedODEKernel().

◆ coupledScalarValueOld()

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

protectedvirtualinherited

Returns the old (previous time step) value of a scalar coupled variable.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Reference to a old VariableValue for the coupled variable

Definition at line 214 of file ScalarCoupleable.C.

 {
   checkVar(var_name);
   if (!isCoupledScalar(var_name, comp))
     return *getDefaultValue(var_name);
  
   validateExecutionerType(var_name, "coupledScalarValueOld");
   MooseVariableScalar * var = getScalarVar(var_name, comp);
   return (_sc_is_implicit) ? var->slnOld() : var->slnOlder();
 }

◆ coupledScalarValueOlder()

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

protectedvirtualinherited

Returns the older (two time steps previous) value of a scalar coupled variable.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Reference to a older VariableValue for the coupled variable

Definition at line 226 of file ScalarCoupleable.C.

 {
   checkVar(var_name);
   if (!isCoupledScalar(var_name, comp))
     return *getDefaultValue(var_name);
  
   validateExecutionerType(var_name, "coupledScalarValueOlder");
   MooseVariableScalar * var = getScalarVar(var_name, comp);
   if (_sc_is_implicit)
     return var->slnOlder();
   else
     mooseError("Older values not available for explicit schemes");
 }

◆ coupledVectorTagScalarValue()

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

protectedvirtualinherited

Returns value of a scalar coupled variable.

Parameters

var_name	Name of coupled variable
tag	Tag ID of coupled vector ;
comp	Component number for vector of coupled variables

Returns: Reference to a VariableValue for the coupled variable

Definition at line 184 of file ScalarCoupleable.C.

 {
   checkVar(var_name);
   if (!isCoupledScalar(var_name, comp))
     return *getDefaultValue(var_name);
  
   addScalarVariableCoupleableVectorTag(tag);
  
   MooseVariableScalar * var = getScalarVar(var_name, comp);
   return var->vectorTagSln(tag);
 }

◆ cyclicDependencyError()

template<typename T >

void DependencyResolverInterface::cyclicDependencyError	(	CyclicDependencyException< T > &	e,
		const std::string &	header
	)

staticinherited

A helper method for cyclic errors.

Definition at line 94 of file DependencyResolverInterface.h.

 {
   std::ostringstream oss;
  
   oss << header << ":\n";
   const typename std::multimap<T, T> & depends = e.getCyclicDependencies();
   for (typename std::multimap<T, T>::const_iterator it = depends.begin(); it != depends.end(); ++it)
     oss << (static_cast<T>(it->first))->name() << " -> " << (static_cast<T>(it->second))->name()
         << "\n";
   mooseError(oss.str());
 }

◆ enabled()

virtual bool MooseObject::enabled ( ) const

inlinevirtualinherited

Return the enabled status of the object.

Reimplemented in EigenKernel.

Definition at line 110 of file MooseObject.h.

110 { return _enabled; }

Referenced by EigenKernel::enabled().

◆ getADDefaultValue()

template<ComputeStage compute_stage>

ADVariableValue* ScalarCoupleable::getADDefaultValue ( const std::string & var_name )

protectedinherited

Helper method to return (and insert if necessary) the AD default value for an uncoupled variable.

Parameters

var_name the name of the variable for which to retrieve a default value

Returns: ADVariableValue * a pointer to the associated ADVariableValue.

◆ getCheckedPointerParam()

template<typename T >

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

inlineinherited

Verifies that the requested parameter exists and is not NULL and returns it to the caller.

The template parameter must be a pointer or an error will be thrown.

Definition at line 91 of file MooseObject.h.

   {
     return parameters().getCheckedPointerParam<T>(name, error_string);
   }

◆ getCoupledMooseScalarVars()

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

inherited

Get the list of coupled scalar variables.

Returns: The list of coupled variables

Definition at line 68 of file ScalarCoupleable.C.

 {
   return _coupled_moose_scalar_vars;
 }

Referenced by AuxScalarKernel::AuxScalarKernel(), and ScalarInitialCondition::ScalarInitialCondition().

◆ getDefaultValue()

VariableValue * ScalarCoupleable::getDefaultValue ( const std::string & var_name )

protectedinherited

Helper method to return (and insert if necessary) the default value for an uncoupled variable.

Parameters

var_name the name of the variable for which to retrieve a default value

Returns: VariableValue * a pointer to the associated VarirableValue.

Definition at line 112 of file ScalarCoupleable.C.

 {
   auto default_value_it = _default_value.find(var_name);
   if (default_value_it == _default_value.end())
   {
     auto value = libmesh_make_unique<VariableValue>(
         _sc_fe_problem.getMaxScalarOrder(), _coupleable_params.defaultCoupledValue(var_name));
     default_value_it = _default_value.insert(std::make_pair(var_name, std::move(value))).first;
   }
  
   return default_value_it->second.get();
 }

Referenced by ScalarCoupleable::coupledMatrixTagScalarValue(), ScalarCoupleable::coupledScalarValue(), ScalarCoupleable::coupledScalarValueOld(), ScalarCoupleable::coupledScalarValueOlder(), and ScalarCoupleable::coupledVectorTagScalarValue().

◆ getFunction()

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

inherited

Get a function with a given name.

Parameters

name	The name of the parameter key of the function to retrieve

Returns: The function with name associated with the parameter 'name'

Definition at line 31 of file FunctionInterface.C.

 {
   return _fni_feproblem.getFunction(_fni_params.get<FunctionName>(name), _fni_tid);
 }

Referenced by FunctionDT::FunctionDT().

◆ getFunctionByName()

const Function & FunctionInterface::getFunctionByName ( const FunctionName & name ) const

inherited

Get a function with a given name.

Parameters

name	The name of the function to retrieve

Returns: The function with name 'name'

Definition at line 37 of file FunctionInterface.C.

 {
   return _fni_feproblem.getFunction(name, _fni_tid);
 }

Referenced by ArrayFunctionIC::ArrayFunctionIC(), CompositeFunction::CompositeFunction(), FunctionScalarAux::FunctionScalarAux(), FunctionScalarIC(), GenericFunctionMaterial::GenericFunctionMaterial(), LinearCombinationFunction::LinearCombinationFunction(), and LineFunctionSampler::LineFunctionSampler().

◆ getMooseApp()

MooseApp& MooseObject::getMooseApp ( ) const

inlineinherited

Get the MooseApp this object is associated with.

Definition at line 105 of file MooseObject.h.

105 { return _app; }

Referenced by MortarData::createMortarInterface(), Executioner::Executioner(), and ConsoleUtils::outputMeshInformation().

◆ getParamTempl()

template<typename T >

const T & MooseObject::getParamTempl ( const std::string & name ) const

inherited

Retrieve a parameter for the object.

Parameters

name	The name of the parameter

Returns: The value of the parameter

Definition at line 208 of file MooseObject.h.

 {
   return InputParameters::getParamHelper(name, _pars, static_cast<T *>(0));
 }

Referenced by FEProblemBase::addMaterialHelper(), ConstraintWarehouse::addObject(), EigenKernel::EigenKernel(), AttribThread::initFrom(), BlockRestrictable::initializeBlockRestrictable(), BoundaryRestrictable::initializeBoundaryRestrictable(), Console::initialSetup(), ConsoleUtils::outputExecutionInformation(), and TimePeriod::TimePeriod().

◆ getRequestedItems()

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

virtualinherited

Return a set containing the names of items requested by the object.

Implements DependencyResolverInterface.

Definition at line 52 of file ScalarInitialCondition.C.

 {
   return _depend_vars;
 }

◆ getScalarVar()

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

protectedinherited

Extract pointer to a scalar coupled variable.

Parameters

var_name	Name of parameter desired
comp	Component number of multiple coupled variables

Returns: Pointer to the desired variable

Definition at line 313 of file ScalarCoupleable.C.

 {
   if (_coupled_scalar_vars.find(var_name) != _coupled_scalar_vars.end())
   {
     if (comp < _coupled_scalar_vars[var_name].size())
       return _coupled_scalar_vars[var_name][comp];
     else
       mooseError(_sc_name, ": Trying to get a non-existent component of variable '", var_name, "'");
   }
   else
     mooseError(_sc_name, ": Trying to get a non-existent variable '", var_name, "'");
 }

◆ getScalarVariableCoupleableMatrixTags()

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

inlineinherited

Definition at line 51 of file ScalarCoupleable.h.

51 { return _sc_coupleable_matrix_tags; }

◆ getScalarVariableCoupleableVectorTags()

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

inlineinherited

Definition at line 49 of file ScalarCoupleable.h.

49 { return _sc_coupleable_vector_tags; }

◆ getSuppliedItems()

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

virtualinherited

Return a set containing the names of items owned by the object.

Implements DependencyResolverInterface.

Definition at line 58 of file ScalarInitialCondition.C.

 {
   return _supplied_vars;
 }

◆ getUserObjectBase()

const UserObject & UserObjectInterface::getUserObjectBase ( const std::string & name )

inherited

Get an user object with a given parameter name.

Parameters

name	The name of the parameter key of the user object to retrieve

Returns: The user object with name associated with the parameter 'name'

Definition at line 24 of file UserObjectInterface.C.

 {
   return _uoi_feproblem.getUserObjectBase(_uoi_params.get<UserObjectName>(name));
 }

Referenced by InitialConditionBase::getUserObjectBase(), AuxKernelTempl< ComputeValueType >::getUserObjectBase(), and UserObjectInterface::getUserObjectTempl().

◆ getUserObjectBaseByName()

const UserObject & UserObjectInterface::getUserObjectBaseByName ( const std::string & name )

inherited

Get an user object with a given name.

Parameters

name	The name of the user object to retrieve

Returns: The user object with the name

Definition at line 30 of file UserObjectInterface.C.

 {
   return _uoi_feproblem.getUserObjectBase(name);
 }

Referenced by UserObjectInterface::getUserObjectByNameTempl().

◆ getUserObjectByNameTempl()

template<class T >

const T & UserObjectInterface::getUserObjectByNameTempl ( const std::string & name )

inherited

Get an user object with a given name.

Parameters

name	The name of the user object to retrieve

Returns: The user object with the name

Definition at line 93 of file UserObjectInterface.h.

 {
   unsigned int tid = needThreadedCopy(getUserObjectBaseByName(name)) ? _uoi_tid : 0;
   return _uoi_feproblem.getUserObjectTempl<T>(name, tid);
 }

◆ getUserObjectTempl()

template<class T >

const T & UserObjectInterface::getUserObjectTempl ( const std::string & name )

inherited

Get an user object with a given parameter name.

Parameters

name	The name of the parameter key of the user object to retrieve

Returns: The user object with name associated with the parameter 'name'

Definition at line 85 of file UserObjectInterface.h.

 {
   unsigned int tid = needThreadedCopy(getUserObjectBase(name)) ? _uoi_tid : 0;
   return _uoi_feproblem.getUserObjectTempl<T>(_uoi_params.get<UserObjectName>(name), tid);
 }

◆ initialSetup()

virtual void ScalarInitialCondition::initialSetup ( )

inlinevirtualinherited

Gets called at the beginning of the simulation before this object is asked to do its job.

Note: This method is normally inherited from SetupInterface. However in this case it makes no sense to inherit the other virtuals available in that class so we are adding this virtual directly to this class with out the extra inheritance.

Definition at line 75 of file ScalarInitialCondition.h.

75 {}

◆ isCoupledScalar()

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

protectedvirtualinherited

Returns true if a variables has been coupled_as name.

Parameters

var_name	The of the coupled variable
i	By default 0, in general the index to test in a vector of MooseVariable pointers.

Definition at line 74 of file ScalarCoupleable.C.

 {
   auto it = _coupled_scalar_vars.find(var_name);
   if (it != _coupled_scalar_vars.end())
     return (i < it->second.size());
   else
   {
     // Make sure the user originally requested this value in the InputParameter syntax
     if (!_coupleable_params.hasCoupledValue(var_name))
       mooseError(_sc_name,
                  ": The coupled scalar variable \"",
                  var_name,
                  "\" was never added to this objects's "
                  "InputParameters, please double-check "
                  "your spelling");
  
     return false;
   }
 }

Referenced by ScalarCoupleable::adCoupledScalarValueTempl(), ScalarCoupleable::coupledMatrixTagScalarValue(), ScalarCoupleable::coupledScalarOrder(), ScalarCoupleable::coupledScalarValue(), ScalarCoupleable::coupledScalarValueOld(), ScalarCoupleable::coupledScalarValueOlder(), and ScalarCoupleable::coupledVectorTagScalarValue().

◆ isParamValid()

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

inlineinherited

Test if the supplied parameter is valid.

Parameters

name	The name of the parameter to test

Definition at line 100 of file MooseObject.h.

100 { return _pars.isParamValid(name); }

◆ mooseDeprecated()

template<typename... Args>

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

inlineinherited

Definition at line 156 of file MooseObject.h.

   {
     moose::internal::mooseDeprecatedStream(_console, false, std::forward<Args>(args)...);
   }

Referenced by FEProblemBase::addArrayVariable(), FEProblemBase::addAuxArrayVariable(), FEProblemBase::addAuxScalarVariable(), FEProblemBase::addAuxVariable(), FEProblemBase::addScalarVariable(), FEProblemBase::addVariable(), ADFunctionPresetBC< compute_stage >::ADFunctionPresetBC(), ADPresetBC< compute_stage >::ADPresetBC(), ADPresetNodalBC< compute_stage >::ADPresetNodalBC(), FEProblemBase::advanceMultiApps(), MultiApp::appProblem(), MooseMesh::buildSideList(), ChangeOverTimestepPostprocessor::ChangeOverTimestepPostprocessor(), FEProblemBase::computeResidual(), MaterialBase::declarePropertyOlderTempl(), MaterialBase::declarePropertyOldTempl(), MooseMesh::elem(), MultiAppTransfer::execFlags(), UserForcingFunction::f(), FaceFaceConstraint< compute_stage >::FaceFaceConstraint(), FunctionDT::FunctionDT(), FunctionPresetBC::FunctionPresetBC(), RandomICBase::generateRandom(), Control::getExecuteOptions(), FEProblemBase::getNonlinearSystem(), Sampler::getSamples(), FEProblemBase::getUserObjects(), FEProblemBase::getVectorPostprocessorValue(), FEProblemBase::getVectorPostprocessorValueOld(), MatDiffusionBase< Real >::MatDiffusionBase(), NodalScalarKernel::NodalScalarKernel(), MooseMesh::node(), PercentChangePostprocessor::PercentChangePostprocessor(), PresetBC::PresetBC(), PresetNodalBC::PresetNodalBC(), Sampler::rand(), ReferenceResidualProblem::ReferenceResidualProblem(), MooseMesh::setBoundaryToNormalMap(), Exodus::setOutputDimension(), and UserForcingFunction::UserForcingFunction().

◆ mooseError()

template<typename... Args>

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

inlineinherited

Definition at line 141 of file MooseObject.h.

   {
     std::ostringstream oss;
     moose::internal::mooseStreamAll(oss, std::forward<Args>(args)...);
     std::string msg = oss.str();
     callMooseErrorRaw(msg, &_app);
   }

◆ mooseInfo()

template<typename... Args>

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

inlineinherited

Definition at line 162 of file MooseObject.h.

   {
     moose::internal::mooseInfoStream(_console, std::forward<Args>(args)...);
   }

Referenced by AStableDirk4::AStableDirk4(), ExplicitRK2::ExplicitRK2(), ExplicitTVDRK2::ExplicitTVDRK2(), ParsedMaterialHelper::functionsOptimize(), ImplicitMidpoint::ImplicitMidpoint(), LStableDirk2::LStableDirk2(), LStableDirk3::LStableDirk3(), LStableDirk4::LStableDirk4(), PNGOutput::makeMeshFunc(), MooseObject::paramInfo(), DerivativeParsedMaterialHelper::recurseDerivative(), ReferenceResidualProblem::ReferenceResidualProblem(), and FEProblemBase::setRestartFile().

◆ mooseWarning()

template<typename... Args>

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

inlineinherited

Definition at line 150 of file MooseObject.h.

   {
     moose::internal::mooseWarningStream(_console, std::forward<Args>(args)...);
   }

Referenced by CartesianMeshGenerator::CartesianMeshGenerator(), MultiAppTransfer::checkMultiAppExecuteOn(), OversampleOutput::cloneMesh(), GapValueAux::computeValue(), ElementQualityChecker::finalize(), FiniteDifferencePreconditioner::FiniteDifferencePreconditioner(), ElementSubdomainIDGenerator::generate(), MooseMesh::getBoundaryIDs(), FEProblemBase::getInterfaceMaterial(), FEProblemBase::getMaterial(), MooseMesh::getSubdomainIDs(), ReferenceResidualProblem::initialSetup(), DerivativeFunctionMaterialBase::initialSetup(), FEProblemBase::initialSetup(), AdvancedOutput::initPostprocessorOrVectorPostprocessorLists(), LeastSquaresFit::LeastSquaresFit(), MaterialVectorPostprocessor::MaterialVectorPostprocessor(), AssignElementSubdomainID::modify(), NewmarkBeta::NewmarkBeta(), NodalPatchRecovery::NodalPatchRecovery(), NonlocalIntegratedBC::NonlocalIntegratedBC(), NonlocalKernel::NonlocalKernel(), Output::Output(), MooseObject::paramWarning(), Executioner::problem(), MaterialBase::resetQpProperties(), FEProblemBase::sizeZeroes(), TransientMultiApp::solveStep(), Tecplot::Tecplot(), and Checkpoint::updateCheckpointFiles().

◆ name()

virtual const std::string& MooseObject::name ( ) const

inlinevirtualinherited

Get the name of the object.

Returns: The name of the object TODO:MooseVariableToMooseObject (see #10601)

Reimplemented in MooseVariableBase.

Definition at line 70 of file MooseObject.h.

70 { return _name; }

◆ needThreadedCopy()

bool UserObjectInterface::needThreadedCopy ( const UserObject & uo ) const

privateinherited

Check if the threaded copy of the user object is needed.

Definition at line 36 of file UserObjectInterface.C.

 {
   return (dynamic_cast<const DiscreteElementUserObject *>(&uo) != NULL) ||
          (dynamic_cast<const ThreadedGeneralUserObject *>(&uo) != NULL);
 }

Referenced by UserObjectInterface::getUserObjectByNameTempl(), and UserObjectInterface::getUserObjectTempl().

◆ paramError()

template<typename... Args>

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

inherited

Emits an error prefixed with the file and line number of the given param (from the input file) along with the full parameter path+name followed by the given args as the message.

If this object's parameters were not created directly by the Parser, then this function falls back to the normal behavior of mooseError - only printing a message using the given args.

Definition at line 215 of file MooseObject.h.

 {
   Moose::show_trace = false;
   mooseError(paramErrorMsg(param, std::forward<Args>(args)...));
   Moose::show_trace = true;
 }

◆ paramErrorMsg()

template<typename... Args>

std::string MooseObject::paramErrorMsg	(	const std::string &	param,
		Args...	args
	)		const

inlineprivateinherited

Definition at line 185 of file MooseObject.h.

   {
     auto prefix = paramErrorPrefix(_pars, param);
     std::ostringstream oss;
     moose::internal::mooseStreamAll(oss, std::forward<Args>(args)...);
     std::string msg = oss.str();
  
     // Wrap error message to a separate line from prefix if it is about to
     // blow past 100 chars.  But only wrap if the prefix is long enough (12
     // chars) for the wrap to buy us much extra length.
     if ((prefix.size() > 12 && msg.size() + prefix.size() > 99) ||
         msg.find("\n") != std::string::npos)
     {
       if (prefix.size() > 0 && prefix[prefix.size() - 1] != ':')
         prefix += ":";
       return prefix + "\n    " + MooseUtils::replaceAll(msg, "\n", "\n    ");
     }
     return prefix + " " + msg;
   }

Referenced by MooseObject::paramError(), MooseObject::paramInfo(), and MooseObject::paramWarning().

◆ parameters()

const InputParameters& MooseObject::parameters ( ) const

inlineinherited

Get the parameters of the object.

Returns: The parameters of the object

Definition at line 76 of file MooseObject.h.

76 { return _pars; }

◆ paramInfo()

template<typename... Args>

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

inherited

Emits an informational message prefixed with the file and line number of the given param (from the input file) along with the full parameter path+name followed by the given args as the message.

If this object's parameters were not created directly by the Parser, then this function falls back to the normal behavior of mooseInfo - only printing a message using the given args.

Definition at line 231 of file MooseObject.h.

 {
   mooseInfo(paramErrorMsg(param, std::forward<Args>(args)...));
 }

Referenced by TransientMultiApp::TransientMultiApp().

◆ paramWarning()

template<typename... Args>

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

inherited

Emits a warning prefixed with the file and line number of the given param (from the input file) along with the full parameter path+name followed by the given args as the message.

If this object's parameters were not created directly by the Parser, then this function falls back to the normal behavior of mooseWarning - only printing a message using the given args.

Definition at line 224 of file MooseObject.h.

 {
   mooseWarning(paramErrorMsg(param, std::forward<Args>(args)...));
 }

Referenced by Executioner::Executioner().

◆ sort()

template<typename T >

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

staticinherited

Given a vector, sort using the getRequested/SuppliedItems sets.

Definition at line 57 of file DependencyResolverInterface.h.

 {
   DependencyResolver<T> resolver;
  
   typename std::vector<T>::iterator start = vector.begin();
   typename std::vector<T>::iterator end = vector.end();
  
   for (typename std::vector<T>::iterator iter = start; iter != end; ++iter)
   {
     const std::set<std::string> & requested_items = (*iter)->getRequestedItems();
  
     for (typename std::vector<T>::iterator iter2 = start; iter2 != end; ++iter2)
     {
       if (iter == iter2)
         continue;
  
       const std::set<std::string> & supplied_items = (*iter2)->getSuppliedItems();
  
       std::set<std::string> intersect;
       std::set_intersection(requested_items.begin(),
                             requested_items.end(),
                             supplied_items.begin(),
                             supplied_items.end(),
                             std::inserter(intersect, intersect.end()));
  
       // If the intersection isn't empty then there is a dependency here
       if (!intersect.empty())
         resolver.insertDependency(*iter, *iter2);
     }
   }
  
   // Sort based on dependencies
   std::stable_sort(start, end, resolver);
 }

Referenced by TheWarehouse::prepare().

◆ type()

const std::string& MooseObject::type ( ) const

inlineinherited

Get the type of this object.

Returns: the name of the type of this object

Definition at line 63 of file MooseObject.h.

63 { return _type; }

◆ validateExecutionerType()

void ScalarCoupleable::validateExecutionerType	(	const std::string &	name,
		const std::string &	fn_name
	)		const

protectedinherited

Checks to make sure that the current Executioner has set "_is_transient" when old/older values are coupled in.

Parameters

name	the name of the variable
fn_name	The name of the function that called this method - used in the error message

Definition at line 327 of file ScalarCoupleable.C.

 {
   if (!_sc_fe_problem.isTransient())
     mooseError(_sc_name,
                ": Calling '",
                fn_name,
                "' on variable \"",
                name,
                "\" when using a \"Steady\" executioner is not allowed. This value is available "
                "only in transient simulations.");
 }

Referenced by ScalarCoupleable::coupledScalarDot(), ScalarCoupleable::coupledScalarDotDot(), ScalarCoupleable::coupledScalarDotDotDu(), ScalarCoupleable::coupledScalarDotDotOld(), ScalarCoupleable::coupledScalarDotDu(), ScalarCoupleable::coupledScalarDotOld(), ScalarCoupleable::coupledScalarValueOld(), and ScalarCoupleable::coupledScalarValueOlder().

◆ validParams()

InputParameters FunctionScalarIC::validParams ( )

static

Definition at line 21 of file FunctionScalarIC.C.

 {
   InputParameters params = ScalarInitialCondition::validParams();
   params.addRequiredParam<std::vector<FunctionName>>("function", "The initial condition function.");
   return params;
 }

◆ value()

Real FunctionScalarIC::value ( )

overrideprotectedvirtual

The value of the variable.

This must be overridden by derived classes.

Implements ScalarInitialCondition.

Definition at line 40 of file FunctionScalarIC.C.

 {
   return _func[_i]->value(_t, _point_zero);
 }

◆ variable()

MooseVariableScalar& ScalarInitialCondition::variable ( )

inlineinherited

Definition at line 55 of file ScalarInitialCondition.h.

55 { return _var; }

Member Data Documentation

◆ _app

MooseApp& MooseObject::_app

protectedinherited

The MooseApp this object is associated with.

Definition at line 172 of file MooseObject.h.

Referenced by GridPartitioner::_do_partition(), AB2PredictorCorrector::AB2PredictorCorrector(), Executioner::addAttributeReporter(), FEProblemBase::addMaterialHelper(), FEProblemBase::addMultiApp(), FEProblemBase::addOutput(), FEProblemBase::allowOutput(), AStableDirk4::AStableDirk4(), FileMesh::buildMesh(), MeshGeneratorMesh::buildMesh(), MooseMesh::buildMeshBaseObject(), FEProblemBase::checkNonlinearConvergence(), OversampleOutput::cloneMesh(), FEProblemBase::computeJacobianTags(), FEProblemBase::computeResidualTags(), Console::Console(), TimeStepper::constrainStep(), MultiApp::createApp(), MeshGenerator::declareMeshProperty(), DumpObjectsProblem::dumpObjectHelper(), DumpObjectsProblem::dumpVariableHelper(), EigenExecutionerBase::EigenExecutionerBase(), EigenKernel::EigenKernel(), NonlinearEigen::execute(), InversePowerMethod::execute(), Transient::execute(), Steady::execute(), FileOutput::FileOutput(), FEProblemBase::forceOutput(), MeshGenerator::getMesh(), MeshGenerator::getMeshByName(), MooseObject::getMooseApp(), NumRelationshipManagers::getValue(), GhostingUserObject::GhostingUserObject(), NonlinearEigen::init(), InversePowerMethod::init(), Transient::init(), Steady::init(), MooseMesh::init(), NumPicardIterations::initialize(), TimePeriod::initialSetup(), Console::initialSetup(), MultiApp::initialSetup(), FEProblemBase::initialSetup(), AdvancedOutput::initOutputList(), FEProblemBase::initPetscOutput(), AdvancedOutput::initPostprocessorOrVectorPostprocessorLists(), ElementSideNeighborLayers::internalInit(), MeshGeneratorMesh::MeshGeneratorMesh(), MooseObject::mooseError(), EigenExecutionerBase::normalizeSolution(), AugmentSparsityOnInterface::operator()(), PerfGraphOutput::output(), Tecplot::output(), Exodus::output(), Nemesis::output(), ControlOutput::outputActiveObjects(), ControlOutput::outputChangedControls(), ControlOutput::outputControls(), Exodus::outputEmptyTimestep(), Console::outputInput(), Exodus::outputInput(), Exodus::outputNodalVariables(), OversampleOutput::outputStep(), Output::outputStep(), FEProblemBase::outputStep(), Console::outputSystemInformation(), MultiApp::parentOutputPositionChanged(), PerformanceData::PerformanceData(), PetscOutput::petscLinearOutput(), PetscOutput::petscNonlinearOutput(), Eigenvalue::postSolve(), Transient::preExecute(), FEProblemBase::projectSolution(), FEProblemBase::setRestartFile(), TransientMultiApp::setupApp(), TimeSequenceStepperBase::setupSequence(), Transient::setupTimeIntegrator(), TransientMultiApp::solveStep(), FEProblemBase::subdomainSetup(), FEProblemBase::theWarehouse(), TimeExtremeValue::TimeExtremeValue(), TimePeriod::TimePeriod(), FEProblemBase::timestepSetup(), Transient::Transient(), and Console::write().

◆ _assembly

Assembly& ScalarInitialCondition::_assembly

protectedinherited

Definition at line 86 of file ScalarInitialCondition.h.

◆ _console

const ConsoleStream ConsoleStreamInterface::_console

inherited

An instance of helper class to write streams to the Console objects.

Definition at line 31 of file ConsoleStreamInterface.h.

◆ _coupleable_params

const InputParameters& ScalarCoupleable::_coupleable_params

protectedinherited

Local InputParameters.

Definition at line 220 of file ScalarCoupleable.h.

Referenced by ScalarCoupleable::getDefaultValue(), and ScalarCoupleable::isCoupledScalar().

◆ _coupled_moose_scalar_vars

std::vector<MooseVariableScalar *> ScalarCoupleable::_coupled_moose_scalar_vars

protectedinherited

Vector of coupled variables.

Definition at line 214 of file ScalarCoupleable.h.

Referenced by ScalarCoupleable::getCoupledMooseScalarVars(), and ScalarCoupleable::ScalarCoupleable().

◆ _coupled_scalar_vars

std::unordered_map<std::string, std::vector<MooseVariableScalar *> > ScalarCoupleable::_coupled_scalar_vars

protectedinherited

Coupled vars whose values we provide.

Definition at line 205 of file ScalarCoupleable.h.

Referenced by ScalarCoupleable::coupledScalarComponents(), ScalarCoupleable::getScalarVar(), ScalarCoupleable::isCoupledScalar(), and ScalarCoupleable::ScalarCoupleable().

◆ _default_value

std::unordered_map<std::string, std::unique_ptr<VariableValue> > ScalarCoupleable::_default_value

protectedinherited

Will hold the default value for optional coupled scalar variables.

Definition at line 208 of file ScalarCoupleable.h.

Referenced by ScalarCoupleable::getDefaultValue().

◆ _depend_vars

std::set<std::string> ScalarInitialCondition::_depend_vars

protectedinherited

Definition at line 95 of file ScalarInitialCondition.h.

Referenced by ScalarInitialCondition::getRequestedItems(), and ScalarInitialCondition::ScalarInitialCondition().

◆ _dual_default_value

std::unordered_map<std::string, std::unique_ptr<DualVariableValue> > ScalarCoupleable::_dual_default_value

protectedinherited

Will hold the default AD value for optional coupled scalar variables.

Definition at line 211 of file ScalarCoupleable.h.

◆ _enabled

const bool& MooseObject::_enabled

protectedinherited

Reference to the "enable" InputParaemters, used by Controls for toggling on/off MooseObjects.

Definition at line 181 of file MooseObject.h.

Referenced by MooseObject::enabled().

◆ _fe_problem

FEProblemBase& ScalarInitialCondition::_fe_problem

protectedinherited

Definition at line 82 of file ScalarInitialCondition.h.

◆ _fni_feproblem

FEProblemBase& FunctionInterface::_fni_feproblem

privateinherited

Reference to FEProblemBase instance.

Definition at line 70 of file FunctionInterface.h.

Referenced by FunctionInterface::getFunction(), and FunctionInterface::getFunctionByName().

◆ _fni_params

const InputParameters& FunctionInterface::_fni_params

privateinherited

Parameters of the object with this interface.

Definition at line 67 of file FunctionInterface.h.

Referenced by FunctionInterface::getFunction().

◆ _fni_tid

const THREAD_ID FunctionInterface::_fni_tid

privateinherited

Thread ID.

Definition at line 73 of file FunctionInterface.h.

Referenced by FunctionInterface::getFunction(), and FunctionInterface::getFunctionByName().

◆ _func

std::vector<const Function *> FunctionScalarIC::_func

protected

Definition at line 32 of file FunctionScalarIC.h.

Referenced by FunctionScalarIC(), and value().

◆ _i

unsigned int ScalarInitialCondition::_i

protectedinherited

Definition at line 93 of file ScalarInitialCondition.h.

Referenced by ScalarInitialCondition::compute(), value(), and ScalarComponentIC::value().

◆ _name

const std::string& MooseObject::_name

protectedinherited

The name of this object, reference to value stored in InputParameters.

Definition at line 178 of file MooseObject.h.

Referenced by ADPiecewiseLinearInterpolationMaterial< compute_stage >::ADPiecewiseLinearInterpolationMaterial(), PiecewiseBase::buildFromFile(), PiecewiseBase::buildFromXY(), PiecewiseLinearBase::buildInterpolation(), CentroidMultiApp::fillPositions(), MultiApp::fillPositions(), FunctionDT::FunctionDT(), MooseObject::name(), PiecewiseBilinear::parse(), PiecewiseBase::PiecewiseBase(), PiecewiseBilinear::PiecewiseBilinear(), PiecewiseLinearInterpolationMaterial::PiecewiseLinearInterpolationMaterial(), DerivativeParsedMaterialHelper::recurseDerivative(), PiecewiseBase::setData(), Split::setup(), and VectorPostprocessorFunction::VectorPostprocessorFunction().

◆ _ncomp

unsigned int FunctionScalarIC::_ncomp

protected

Definition at line 31 of file FunctionScalarIC.h.

Referenced by FunctionScalarIC().

◆ _pars

const InputParameters& MooseObject::_pars

protectedinherited

Parameters of this object, references the InputParameters stored in the InputParametersWarehouse.

Definition at line 169 of file MooseObject.h.

Referenced by GridPartitioner::_do_partition(), BreakMeshByBlockGeneratorBase::BreakMeshByBlockGeneratorBase(), PNGOutput::calculateRescalingValues(), BreakMeshByBlockBase::checkInputParameter(), RandomPartitioner::clone(), PetscExternalPartitioner::clone(), BlockWeightedPartitioner::clone(), GridPartitioner::clone(), Console::Console(), Eigenvalue::execute(), Executioner::Executioner(), FEProblemSolve::FEProblemSolve(), FunctionMaterialBase::FunctionMaterialBase(), ParsedMaterialHelper::functionParse(), ExtraNodesetGenerator::generate(), MooseObject::getParamTempl(), GeneralUserObject::getPostprocessorValue(), InitialConditionBase::getUserObjectBase(), InitialConditionBase::getUserObjectTempl(), GeneralUserObject::getVectorPostprocessorValue(), Transient::init(), AdvancedOutput::initExecutionTypes(), Console::initialSetup(), MooseObject::isParamValid(), AddExtraNodeset::modify(), MooseObject::paramErrorMsg(), MooseObject::parameters(), MooseMesh::setPartitionerHelper(), and Transient::setupTimeIntegrator().

◆ _point_zero

const Point& ScalarCoupleable::_point_zero

protectedinherited

Zero point.

Definition at line 232 of file ScalarCoupleable.h.

Referenced by FunctionDT::computeDT(), FunctionScalarAux::computeValue(), and value().

◆ _real_zero

const Real& ScalarCoupleable::_real_zero

protectedinherited

Scalar zero.

Definition at line 226 of file ScalarCoupleable.h.

◆ _sc_coupleable_matrix_tags

std::set<TagID> ScalarCoupleable::_sc_coupleable_matrix_tags

privateinherited

Definition at line 280 of file ScalarCoupleable.h.

Referenced by ScalarCoupleable::addScalarVariableCoupleableMatrixTag(), and ScalarCoupleable::getScalarVariableCoupleableMatrixTags().

◆ _sc_coupleable_vector_tags

std::set<TagID> ScalarCoupleable::_sc_coupleable_vector_tags

privateinherited

Definition at line 278 of file ScalarCoupleable.h.

Referenced by ScalarCoupleable::addScalarVariableCoupleableVectorTag(), and ScalarCoupleable::getScalarVariableCoupleableVectorTags().

◆ _sc_coupled_vars

std::unordered_map<std::string, std::vector<MooseVariableFEBase *> > ScalarCoupleable::_sc_coupled_vars

privateinherited

Field variables coupled into this object (for error checking)

Definition at line 276 of file ScalarCoupleable.h.

Referenced by ScalarCoupleable::checkVar(), and ScalarCoupleable::ScalarCoupleable().

◆ _sc_fe_problem

FEProblemBase& ScalarCoupleable::_sc_fe_problem

protectedinherited

Definition at line 202 of file ScalarCoupleable.h.

Referenced by ScalarCoupleable::coupledScalarOrder(), ScalarCoupleable::getDefaultValue(), and ScalarCoupleable::validateExecutionerType().

◆ _sc_is_implicit

bool ScalarCoupleable::_sc_is_implicit

protectedinherited

True if implicit value is required.

Definition at line 217 of file ScalarCoupleable.h.

Referenced by ScalarCoupleable::adCoupledScalarValueTempl(), ScalarCoupleable::coupledScalarValue(), ScalarCoupleable::coupledScalarValueOld(), and ScalarCoupleable::coupledScalarValueOlder().

◆ _sc_name

const std::string& ScalarCoupleable::_sc_name

protectedinherited

The name of the object this interface is part of.

Definition at line 62 of file ScalarCoupleable.h.

Referenced by ScalarCoupleable::checkVar(), ScalarCoupleable::getScalarVar(), ScalarCoupleable::isCoupledScalar(), ScalarCoupleable::ScalarCoupleable(), and ScalarCoupleable::validateExecutionerType().

◆ _sc_parameters

const InputParameters& ScalarCoupleable::_sc_parameters

protectedinherited

Definition at line 59 of file ScalarCoupleable.h.

Referenced by ScalarCoupleable::ScalarCoupleable().

◆ _sc_tid

THREAD_ID ScalarCoupleable::_sc_tid

protectedinherited

Thread ID of the thread using this object.

Definition at line 223 of file ScalarCoupleable.h.

Referenced by ScalarCoupleable::ScalarCoupleable().

◆ _scalar_zero

const VariableValue& ScalarCoupleable::_scalar_zero

protectedinherited

Zero value of a scalar variable.

Definition at line 229 of file ScalarCoupleable.h.

◆ _supplied_vars

std::set<std::string> ScalarInitialCondition::_supplied_vars

protectedinherited

Definition at line 96 of file ScalarInitialCondition.h.

Referenced by ScalarInitialCondition::getSuppliedItems(), and ScalarInitialCondition::ScalarInitialCondition().

◆ _sys

SystemBase& ScalarInitialCondition::_sys

protectedinherited

Definition at line 83 of file ScalarInitialCondition.h.

◆ _t

Real& ScalarInitialCondition::_t

protectedinherited

Time.

Definition at line 88 of file ScalarInitialCondition.h.

Referenced by value().

◆ _tid

THREAD_ID ScalarInitialCondition::_tid

protectedinherited

Definition at line 84 of file ScalarInitialCondition.h.

◆ _type

const std::string& MooseObject::_type

protectedinherited

The type of this object (the Class name)

Definition at line 175 of file MooseObject.h.

Referenced by FEProblemBase::init(), and MooseObject::type().

◆ _uoi_feproblem

FEProblemBase& UserObjectInterface::_uoi_feproblem

privateinherited

Reference to the FEProblemBase instance.

Definition at line 74 of file UserObjectInterface.h.

Referenced by UserObjectInterface::getUserObjectBase(), UserObjectInterface::getUserObjectBaseByName(), UserObjectInterface::getUserObjectByNameTempl(), and UserObjectInterface::getUserObjectTempl().

◆ _uoi_params

const InputParameters& UserObjectInterface::_uoi_params

privateinherited

Parameters of the object with this interface.

Definition at line 71 of file UserObjectInterface.h.

Referenced by UserObjectInterface::getUserObjectBase(), and UserObjectInterface::getUserObjectTempl().

◆ _uoi_tid

THREAD_ID UserObjectInterface::_uoi_tid

privateinherited

Thread ID.

Definition at line 77 of file UserObjectInterface.h.

Referenced by UserObjectInterface::getUserObjectByNameTempl(), and UserObjectInterface::getUserObjectTempl().

◆ _var

MooseVariableScalar& ScalarInitialCondition::_var

protectedinherited

Scalar variable this initial condition works on.

Definition at line 91 of file ScalarInitialCondition.h.

Referenced by ScalarInitialCondition::compute(), ScalarComponentIC::ScalarComponentIC(), and ScalarInitialCondition::variable().

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

include/ics/FunctionScalarIC.h
src/ics/FunctionScalarIC.C

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ FunctionScalarIC()

Member Function Documentation

◆ adCoupledScalarValueTempl()

◆ addScalarVariableCoupleableMatrixTag()

◆ addScalarVariableCoupleableVectorTag()

◆ checkVar()

◆ compute()

◆ coupledMatrixTagScalarValue()

◆ coupledScalar()

◆ coupledScalarComponents()

◆ coupledScalarDot()

◆ coupledScalarDotDot()

◆ coupledScalarDotDotDu()

◆ coupledScalarDotDotOld()

◆ coupledScalarDotDu()

◆ coupledScalarDotOld()

◆ coupledScalarOrder()

◆ coupledScalarValue()

◆ coupledScalarValueOld()

◆ coupledScalarValueOlder()

◆ coupledVectorTagScalarValue()

◆ cyclicDependencyError()

◆ enabled()

◆ getADDefaultValue()

◆ getCheckedPointerParam()

◆ getCoupledMooseScalarVars()

◆ getDefaultValue()

◆ getFunction()

◆ getFunctionByName()

◆ getMooseApp()

◆ getParamTempl()

◆ getRequestedItems()

◆ getScalarVar()

◆ getScalarVariableCoupleableMatrixTags()

◆ getScalarVariableCoupleableVectorTags()

◆ getSuppliedItems()

◆ getUserObjectBase()

◆ getUserObjectBaseByName()

◆ getUserObjectByNameTempl()

◆ getUserObjectTempl()

◆ initialSetup()

◆ isCoupledScalar()

◆ isParamValid()

◆ mooseDeprecated()

◆ mooseError()

◆ mooseInfo()

◆ mooseWarning()

◆ name()

◆ needThreadedCopy()

◆ paramError()

◆ paramErrorMsg()

◆ parameters()

◆ paramInfo()

◆ paramWarning()

◆ sort()

◆ type()

◆ validateExecutionerType()

◆ validParams()

◆ value()

◆ variable()

Member Data Documentation

◆ _app

◆ _assembly

◆ _console

◆ _coupleable_params

◆ _coupled_moose_scalar_vars

◆ _coupled_scalar_vars

◆ _default_value

◆ _depend_vars

◆ _dual_default_value

◆ _enabled