klionegg.blogg.se

Doxygen param type python
Doxygen param type python










Returns the path of a data file for a given relative file path. GetDataFileNameByName (const std::string & name, const std::string *param=nullptr) const Returns the path of a data file for a given FileName type parameter, searching (in the following order) More. GetDataFileName (const std::string ¶m) const More.ĮrrorPrefix (const std::string &error_type) constĪ descriptive prefix for errors for this object: More. args) constĮmits a warning without the prefixing included in mooseWarning(). More.Įmits a warning prefixed with object name and type.

doxygen param type python

args) constĮmits an error without the prefixing included in mooseError(). More.Įmits an error prefixed with object name and type.

#Doxygen param type python full

args) constĮmits 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. ParamInfo (const std::string ¶m, Args. args) constĮmits 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. ParamWarning (const std::string ¶m, Args. args) constĮmits 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. ParamError (const std::string ¶m, Args. Get the MooseApp this object is associated with. IsParamValid (const std::string & name) const Verifies that the requested parameter exists and is not NULL and returns it to the caller. GetCheckedPointerParam (const std::string & name, const std::string &error_string="") const Retrieve two parameters and provide pair of parameters for the object. GetParam (const std::string ¶m1, const std::string ¶m2) const GetParam (const std::string & name) const Get the object's combined type and name useful in error handling. The unique parameter name of a valid parameter of this object for accessing parameter controls. UniqueParameterName (const std::string ¶meter_name) const Return a set containing the names of items owned by the object. Return a set containing the names of items requested by the object. Whether or not a threaded copy of this object is needed when obtaining it in another object, like via the UserObjectInterface. Recursively return a set of user objects this user object depends on Note: this can be called only after all user objects are constructed. SetPrimaryThreadCopy ( UserObject *primary) Gather the parallel value of a variable according to which process has the parallel minimum of the provided value. GatherProxyValueMin (T1 & value, T2 &proxy)

doxygen param type python

Gather the parallel value of a variable according to which process has the parallel maximum of the provided value. GatherProxyValueMax (T1 & value, T2 &proxy) Gather the parallel min of the variable passed in.

doxygen param type python

Gather the parallel max of the variable passed in. Gather the parallel sum of the variable passed in. Optional interface function for providing the points at which a UserObject attains spatial values. Optional interface function for "evaluating" a UserObject at a spatial position.

doxygen param type python

Returns whether or not this user object should be executed twice during the initial condition when depended upon by an IC. Returns a reference to the subproblem that this postprocessor is tied to. More.Ĭalled before execute() is ever called so that data can be cleared. Gets called at the beginning of the simulation before this object is asked to do its job. ĮlementSubdomainModifier (const InputParameters & parameters) This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.










Doxygen param type python