SolutionCommand: Difference between revisions

From Flooxs
Jump to navigation Jump to search
(New page: = Solution Command = solution - get and set solution parameters for generic solutions using [language.htm alagator] == Synopsis == === solution === [add] [list] [present] [nosolve] [i...)
 
No edit summary
 
Line 14: Line 14:


[name = <c>]
[name = <c>]
[alias = <c>]


== Description ==
== Description ==
Line 33: Line 34:
; name
; name
: The character string used for the solution. Capitalization is not ignored. "Boron" and "boron" are different. Abbreviations of the name are also not accepted.
: The character string used for the solution. Capitalization is not ignored. "Boron" and "boron" are different. Abbreviations of the name are also not accepted.
; alias
: This how you get around the problems created by "Capitalization is not ignored. "Boron" and "boron" are different. Abbreviations of the name are also not accepted."  A user can create shorthand names, different capitalizations, and abbreviations to the main name.


== Examples ==
== Examples ==
Line 56: Line 59:
Return a boolean true if Int has been defined and there is a data field with the name Int.
Return a boolean true if Int has been defined and there is a data field with the name Int.


== Bugs and Missing Features ==
solution name = Interstitial alias Int
 
Adds an alias to Interstitial to Int so that either string will point at the same solution.


None.


== See Also ==
== See Also ==

Latest revision as of 19:28, 18 June 2020

Solution Command

solution - get and set solution parameters for generic solutions using [language.htm alagator]

Synopsis

solution

[add] [list] [present]

[nosolve] [ifpresent=<c>] [solve]

[damp] [negative]

[name = <c>] [alias = <c>]

Description

This command allows the user to create and modify solution names and set conditions for their inclusion in the assembly. Solutions can also be listed and checked.

add
Create a new solution.
list
List all of the currently defined solutions.
present
Return a true if the solution is defined and a data field matches the name.
nosolve, solve, ifpresent
Only one of these options can be used at a time. They control the solution status for the next command. Nosolve indicates do not solve and solve turns solution status for the next command. Ifpresent sets up a conditional solve. If the all the solutions in the specified list are also being solved, then this solution is solved for.
damp
Damp the Newton iteration updates for this solution.
negative
Allow the solution specified to have negative values.
name
The character string used for the solution. Capitalization is not ignored. "Boron" and "boron" are different. Abbreviations of the name are also not accepted.
alias
This how you get around the problems created by "Capitalization is not ignored. "Boron" and "boron" are different. Abbreviations of the name are also not accepted." A user can create shorthand names, different capitalizations, and abbreviations to the main name.

Examples

solution name=Potential damp negative solve add

Create a solution named potential and always solve for it. Allow the solution to have negative values, and use damping on the Newton iteration updates.

solution name = Int !damp !negative solve add

Create a solution name Int and always solve for it. Do not use damping and do not allow values to become negative.

solution name = I2 !damp !negative ifpresent = {Int Vac} add

Create a solution named I2 and solve for it if Int and Vac are also present and being solved for.

solution list

Return a list of all solutions.

solution name = Int present

Return a boolean true if Int has been defined and there is a data field with the name Int.

solution name = Interstitial alias Int

Adds an alias to Interstitial to Int so that either string will point at the same solution.


See Also

[tutorials.htm language tutorials], [language.htm language definition], [callback.htm callback procedures], [eqn.htm eqn], [solutions.htm solution], [examples.htm Alagator Examples]

[../Intro.html FLOOPS/FLOODS Home Page]