METHODS - Revision history

Jpye at 02:06, 28 September 2014

2014-09-28T02:06:50Z

← Older revision		Revision as of 02:06, 28 September 2014
Line 1:		Line 1:
	~~<div class="notice metadata" id="~~stub~~">''This article is a '''stub'''. You can help out by <span class="plainlinks">[http://ascendwiki.cheme.cmu.edu/index.php?title=METHODS&action=edit expanding it]</span>. ''</div>~~		{{stub}}

	The ~~<strong class="selflink">~~METHODS~~</strong>~~ part of a [[MODEL]] is where procedural statements are contained. In this part of your model declaration, you can not declare new [[Variable\|variables]] or [[Equation\|equations]], but you can set the values of [[Variable\|variables]], make [[Equation\|equations]] active/inactive, perform bounds checking and run [[External Methods]].		The '''METHODS''' part of a [[MODEL]] is where procedural statements are contained. In this part of your model declaration, you can not declare new [[Variable\|variables]] or [[Equation\|equations]], but you can set the values of [[Variable\|variables]], make [[Equation\|equations]] active/inactive, perform bounds checking and run [[External Methods]].

	See [[Thin-walled_tank/Adding_methods_to_a_model]] for an introduction to the use of METHODS including some 'standard' method naming conventions.		See [[Thin-walled_tank/Adding_methods_to_a_model]] for an introduction to the use of METHODS including some 'standard' method naming conventions.
Line 43:		Line 43:
	: This method runs <tt>ClearAll</tt> and then attempts to run the <tt>specify</tt> method. That means that all the FIXed and FREEd varibles should end up reset to their desired states.		: This method runs <tt>ClearAll</tt> and then attempts to run the <tt>specify</tt> method. That means that all the FIXed and FREEd varibles should end up reset to their desired states.





	~~[[Category:Stubs]]~~
	[[Category:Documentation]]		[[Category:Documentation]]
	[[Category:Syntax]]		[[Category:Syntax]]

Jpye: /* Standard METHOD names */

2010-08-02T04:26:17Z

Standard METHOD names

← Older revision		Revision as of 04:26, 2 August 2010
Line 8:		Line 8:

	There is a suggested set of names for METHODs that you should consider using in a model if you would like to make it easy for other people to reuse it. These are		There is a suggested set of names for METHODs that you should consider using in a model if you would like to make it easy for other people to reuse it. These are

			* '''<tt>on_load</tt>'''
			: Write this method to make calls to the other METHODs in suitable sequence. The intention here is that after the GUI automatically runs this method, the model should be in a state where it 'just solves', so that the user can see what the results are.

			* '''<tt>default</tt>'''
			: Write this method to set initial guesses for any variables that you want to set. This method is used as part of [[automatic recursive initialisation]].

	* '''<tt>specify</tt>'''		* '''<tt>specify</tt>'''
Line 23:		Line 29:
	* '''<tt>[[Scaling\|scale_self]]</tt>'''		* '''<tt>[[Scaling\|scale_self]]</tt>'''
	: Set (or re-set) the scaling for your model. Correct model [[scaling]] is critical for the good numerical behaviour of some models. Sometimes it can even be useful to re-scale the model after solving it with some 'easy' initial conditions.		: Set (or re-set) the scaling for your model. Correct model [[scaling]] is critical for the good numerical behaviour of some models. Sometimes it can even be useful to re-scale the model after solving it with some 'easy' initial conditions.

	* '''<tt>on_load</tt>'''
	: Write this method to make calls to the other METHODs in suitable sequence. The intention here is that after the GUI automatically runs this method, the model should be in a state where it 'just solves', so that the user can see what the results are.

	* '''<tt>self_test</tt>'''		* '''<tt>self_test</tt>'''

Jpye at 03:14, 17 May 2010

2010-05-17T03:14:14Z

← Older revision		Revision as of 03:14, 17 May 2010
Line 2:		Line 2:

	The <strong class="selflink">METHODS</strong> part of a [[MODEL]] is where procedural statements are contained. In this part of your model declaration, you can not declare new [[Variable\|variables]] or [[Equation\|equations]], but you can set the values of [[Variable\|variables]], make [[Equation\|equations]] active/inactive, perform bounds checking and run [[External Methods]].		The <strong class="selflink">METHODS</strong> part of a [[MODEL]] is where procedural statements are contained. In this part of your model declaration, you can not declare new [[Variable\|variables]] or [[Equation\|equations]], but you can set the values of [[Variable\|variables]], make [[Equation\|equations]] active/inactive, perform bounds checking and run [[External Methods]].


	See [[Thin-walled_tank/Adding_methods_to_a_model]] for an introduction to the use of METHODS including some 'standard' method naming conventions.		See [[Thin-walled_tank/Adding_methods_to_a_model]] for an introduction to the use of METHODS including some 'standard' method naming conventions.


	== Standard METHOD names ==		== Standard METHOD names ==

	There is a suggested set of names for METHODs that you should consider using in a model if you would like to make it easy for other people to reuse it. These are		There is a suggested set of names for METHODs that you should consider using in a model if you would like to make it easy for other people to reuse it. These are


	* '''<tt>specify</tt>'''		* '''<tt>specify</tt>'''

WikiSysop: /* Built-in methods */

2010-05-14T06:52:50Z

Built-in methods

← Older revision		Revision as of 06:52, 14 May 2010
Line 38:		Line 38:

	* '''<tt>ClearAll</tt>'''		* '''<tt>ClearAll</tt>'''
	:~~<dl><dd>~~ This method automatically ~~<a href="/~~FREE~~" title="FREE">FREEs</a> all variables in the whole model tree.~~		: This method automatically [[FREE]]s all variables in the whole model tree.
	~~</dd></dl>~~

	~~: This method automatically <a href="/FREE" title="FREE">FREEs</a>~~ all variables in the whole model tree.



	* '''<tt>reset</tt>'''		* '''<tt>reset</tt>'''
	~~:<dl><dd> This method runs <tt>ClearAll</tt> and then attempts to run the <tt>specify</tt> method. That means that all the FIXed and FREEd varibles should end up reset to their desired states.~~
	~~</dd></dl>~~

	: This method runs <tt>ClearAll</tt> and then attempts to run the <tt>specify</tt> method. That means that all the FIXed and FREEd varibles should end up reset to their desired states.		: This method runs <tt>ClearAll</tt> and then attempts to run the <tt>specify</tt> method. That means that all the FIXed and FREEd varibles should end up reset to their desired states.

WikiSysop: /* Standard METHOD names */

2010-05-14T06:52:28Z

Standard METHOD names

← Older revision		Revision as of 06:52, 14 May 2010
Line 13:		Line 13:

	* '''<tt>specify</tt>'''		* '''<tt>specify</tt>'''
	~~:<dl><dd> In this method, <a href="/RUN" title="RUN">RUN</a> <tt>ClearAll</tt>, then <a href="/FIX" title="FIX">FIX</a> any variables that you would like to set as known values.~~		: In this method, [[RUN]] <tt>ClearAll</tt>, then [[FIX]] any variables that you would like to set as known values.

	~~</dd></dl>~~

	: In this method, ~~<a href="/~~RUN~~" title="RUN">RUN</a>~~ <tt>ClearAll</tt>, then ~~<a href="/FIX" title="FIX">~~FIX~~</a>~~ any variables that you would like to set as known values.




	* '''<tt>values</tt>'''		* '''<tt>values</tt>'''
	~~:<dl><dd> In this method, set the values of your FIXed variables.~~
	~~</dd></dl>~~

	: In this method, set the values of your FIXed variables.		: In this method, set the values of your FIXed variables.



	* '''<tt>default_self</tt>'''		* '''<tt>default_self</tt>'''
	:<dl><dd> Set any other default values for variables in your model. Often, setting these default (initial/pre-solve) values this is necessary in order for your model to converge to the desired solution.
	~~</dd></dl>~~

	: Set any other default values for variables in your model. Often, setting these default (initial/pre-solve) values this is necessary in order for your model to converge to the desired solution.		: Set any other default values for variables in your model. Often, setting these default (initial/pre-solve) values this is necessary in order for your model to converge to the desired solution.



	* '''<tt>bound_self</tt>'''		* '''<tt>bound_self</tt>'''
	:~~<dl><dd>~~ Set the ~~<a href="/Upper_bound" title="Upper bound">~~upper_bound~~</a>~~ and ~~<a href="/Lower_bound" title="Lower bound">~~lower_bound~~</a>~~ for any variables that don't already have suitable bounds from their ~~<a href="/~~ATOM~~" title="ATOM">ATOM</a> definitions.~~		: Set the [[upper_bound]] and [[lower_bound]] for any variables that don't already have suitable bounds from their [[ATOM]] definitions.
	~~</dd></dl>~~

	: Set the <a href="/Upper_bound" title="Upper bound">upper_bound</a> and <a href="/Lower_bound" title="Lower bound">lower_bound</a> for any variables that don't already have suitable bounds from their <a href="/ATOM" title="ATOM">ATOM</a> definitions.



	* '''<tt>[[Scaling\|scale_self]]</tt>'''		* '''<tt>[[Scaling\|scale_self]]</tt>'''
	:~~<dl><dd>~~ Set (or re-set) the scaling for your model. Correct model ~~<a href="/Scaling" title="Scaling">~~scaling~~</a>~~ is critical for the good numerical behaviour of some models. Sometimes it can even be useful to re-scale the model after solving it with some 'easy' initial conditions.		: Set (or re-set) the scaling for your model. Correct model [[scaling]] is critical for the good numerical behaviour of some models. Sometimes it can even be useful to re-scale the model after solving it with some 'easy' initial conditions.
	~~</dd></dl>~~

	: Set (or re-set) the scaling for your model. Correct model <a href="/Scaling" title="Scaling">scaling</a> is critical for the good numerical behaviour of some models. Sometimes it can even be useful to re-scale the model after solving it with some 'easy' initial conditions.



	* '''<tt>on_load</tt>'''		* '''<tt>on_load</tt>'''
	:<dl><dd> Write this method to make calls to the other METHODs in suitable sequence. The intention here is that after the GUI automatically runs this method, the model should be in a state where it 'just solves', so that the user can see what the results are.

	~~</dd></dl>~~

	: Write this method to make calls to the other METHODs in suitable sequence. The intention here is that after the GUI automatically runs this method, the model should be in a state where it 'just solves', so that the user can see what the results are.		: Write this method to make calls to the other METHODs in suitable sequence. The intention here is that after the GUI automatically runs this method, the model should be in a state where it 'just solves', so that the user can see what the results are.




	* '''<tt>self_test</tt>'''		* '''<tt>self_test</tt>'''
	:~~<dl><dd>~~Write this method with ~~<a href="/index.php?title=~~ASSERT~~&action=edit&redlink=1" class="new" title="ASSERT (page does not exist)">ASSERT</a>~~ statements to check that your model solves to the expected values. This allows you to quickly check that the model is working as you want, before then proceeding to use it for your other purposes. See ~~<a href="/Model_self-testing" title="Model self-testing">Model self-testing</a>.~~		:Write this method with [[ASSERT]] statements to check that your model solves to the expected values. This allows you to quickly check that the model is working as you want, before then proceeding to use it for your other purposes. See [[Model self-testing]].
	~~</dd></dl>~~

	:Write this method with <a href="/index.php?title=ASSERT&action=edit&redlink=1" class="new" title="ASSERT (page does not exist)">ASSERT</a> statements to check that your model solves to the expected values. This allows you to quickly check that the model is working as you want, before then proceeding to use it for your other purposes. See <a href="/Model_self-testing" title="Model self-testing">Model self-testing~~</a>~~.



	Sometimes models require an unusual set of METHODs in order to be configured to solve the problem at hand. In this case, it is recommended that instructions for solving your model be added using [[NOTES]] on the model, perhaps giving the notes category as "solving", for example.		Sometimes models require an unusual set of METHODs in order to be configured to solve the problem at hand. In this case, it is recommended that instructions for solving your model be added using [[NOTES]] on the model, perhaps giving the notes category as "solving", for example.



	== Built-in methods ==		== Built-in methods ==

UploadBot: Restored page from Google Cache, uploaded by John Pye

2010-05-13T13:52:14Z

Restored page from Google Cache, uploaded by John Pye

New page

<div class="notice metadata" id="stub">''This article is a '''stub'''. You can help out by <span class="plainlinks">[http://ascendwiki.cheme.cmu.edu/index.php?title=METHODS&action=edit expanding it]</span>. ''</div>

The <strong class="selflink">METHODS</strong> part of a [[MODEL]] is where procedural statements are contained. In this part of your model declaration, you can not declare new [[Variable|variables]] or [[Equation|equations]], but you can set the values of [[Variable|variables]], make [[Equation|equations]] active/inactive, perform bounds checking and run [[External Methods]].

See [[Thin-walled_tank/Adding_methods_to_a_model]] for an introduction to the use of METHODS including some 'standard' method naming conventions.

== Standard METHOD names ==

There is a suggested set of names for METHODs that you should consider using in a model if you would like to make it easy for other people to reuse it. These are

* '''<tt>specify</tt>'''
:<dl><dd> In this method, <a href="/RUN" title="RUN">RUN</a> <tt>ClearAll</tt>, then <a href="/FIX" title="FIX">FIX</a> any variables that you would like to set as known values.

</dd></dl>

: In this method, <a href="/RUN" title="RUN">RUN</a> <tt>ClearAll</tt>, then <a href="/FIX" title="FIX">FIX</a> any variables that you would like to set as known values.

* '''<tt>values</tt>'''
:<dl><dd> In this method, set the values of your FIXed variables.
</dd></dl>

: In this method, set the values of your FIXed variables.

* '''<tt>default_self</tt>'''
:<dl><dd> Set any other default values for variables in your model. Often, setting these default (initial/pre-solve) values this is necessary in order for your model to converge to the desired solution.
</dd></dl>

: Set any other default values for variables in your model. Often, setting these default (initial/pre-solve) values this is necessary in order for your model to converge to the desired solution.

* '''<tt>bound_self</tt>'''
:<dl><dd> Set the <a href="/Upper_bound" title="Upper bound">upper_bound</a> and <a href="/Lower_bound" title="Lower bound">lower_bound</a> for any variables that don't already have suitable bounds from their <a href="/ATOM" title="ATOM">ATOM</a> definitions.
</dd></dl>

: Set the <a href="/Upper_bound" title="Upper bound">upper_bound</a> and <a href="/Lower_bound" title="Lower bound">lower_bound</a> for any variables that don't already have suitable bounds from their <a href="/ATOM" title="ATOM">ATOM</a> definitions.

* '''<tt>[[Scaling|scale_self]]</tt>'''
:<dl><dd> Set (or re-set) the scaling for your model. Correct model <a href="/Scaling" title="Scaling">scaling</a> is critical for the good numerical behaviour of some models. Sometimes it can even be useful to re-scale the model after solving it with some 'easy' initial conditions.
</dd></dl>

: Set (or re-set) the scaling for your model. Correct model <a href="/Scaling" title="Scaling">scaling</a> is critical for the good numerical behaviour of some models. Sometimes it can even be useful to re-scale the model after solving it with some 'easy' initial conditions.

* '''<tt>on_load</tt>'''
:<dl><dd> Write this method to make calls to the other METHODs in suitable sequence. The intention here is that after the GUI automatically runs this method, the model should be in a state where it 'just solves', so that the user can see what the results are.

</dd></dl>

: Write this method to make calls to the other METHODs in suitable sequence. The intention here is that after the GUI automatically runs this method, the model should be in a state where it 'just solves', so that the user can see what the results are.

* '''<tt>self_test</tt>'''
:<dl><dd>Write this method with <a href="/index.php?title=ASSERT&action=edit&redlink=1" class="new" title="ASSERT (page does not exist)">ASSERT</a> statements to check that your model solves to the expected values. This allows you to quickly check that the model is working as you want, before then proceeding to use it for your other purposes. See <a href="/Model_self-testing" title="Model self-testing">Model self-testing</a>.
</dd></dl>

:Write this method with <a href="/index.php?title=ASSERT&action=edit&redlink=1" class="new" title="ASSERT (page does not exist)">ASSERT</a> statements to check that your model solves to the expected values. This allows you to quickly check that the model is working as you want, before then proceeding to use it for your other purposes. See <a href="/Model_self-testing" title="Model self-testing">Model self-testing</a>.

Sometimes models require an unusual set of METHODs in order to be configured to solve the problem at hand. In this case, it is recommended that instructions for solving your model be added using [[NOTES]] on the model, perhaps giving the notes category as "solving", for example.

== Built-in methods ==

* '''<tt>ClearAll</tt>'''
:<dl><dd> This method automatically <a href="/FREE" title="FREE">FREEs</a> all variables in the whole model tree.
</dd></dl>

: This method automatically <a href="/FREE" title="FREE">FREEs</a> all variables in the whole model tree.

* '''<tt>reset</tt>'''
:<dl><dd> This method runs <tt>ClearAll</tt> and then attempts to run the <tt>specify</tt> method. That means that all the FIXed and FREEd varibles should end up reset to their desired states.
</dd></dl>

: This method runs <tt>ClearAll</tt> and then attempts to run the <tt>specify</tt> method. That means that all the FIXed and FREEd varibles should end up reset to their desired states.

[[Category:Stubs]]
[[Category:Documentation]]
[[Category:Syntax]]