Latest revision as of 19:45, 18 June 2020

Mater Command

mater - get and set material properties. Parameters are set as part of alagator.

Synopsis

mater

[list] [bulk] [all]

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

[ white | black | red | green | blue | aquamarine | brown | purple | cyan | turquoise | magenta | grey | yellow | pink | wheat | salmon ]

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 materal.
name: The character string used for the material. Capitalization is not ignored. "Silicon" and "silicon" are different. Abbreviations of the name are also not accepted.
alias: This how you get around the problems created by "Capitalization is not ignored. "Silicon" and "silicon" are different. Abbreviations of the name are also not accepted." A user can create shorthand names, different capitalizations, and abbreviations to the main name.
color: Define a default color to be used when plotting this material.
list, all, bulk: The list option will list all of the currently defined materials in the active structure. All will list all materials that have been defined, even if they ar not currently present. Bulk modifies both of the previous options to list bulk materials only and not interfaces.

Examples

mater name=Silicon green alias=Si

Create a material name Silicon with an alias of Si and set the default color to green.

mater list

Return a list of all materials in the current structure.

mater list bulk

Return a list of all bull materials in the current structure.

@@ Line 7: / Line 7: @@
 === mater ===
-[list] [bulk] [all]
+ [list] [bulk] [all]
-[add]
-[name = &lt;c&gt;]
+ [add]
-[alias = &lt;c&gt;]
+ [name = &lt;c&gt;]
+ [alias = &lt;c&gt;]
+ [ white | black | red | green | blue | aquamarine | brown | purple | cyan | turquoise | magenta | grey | yellow | pink | wheat | salmon ]
 == Description ==
@@ Line 22: / Line 25: @@
 ; alias
 : This how you get around the problems created by "Capitalization is not ignored. "Silicon" and "silicon" are different. Abbreviations of the name are also not accepted."  A user can create shorthand names, different capitalizations, and abbreviations to the main name.
+; color
+: Define a default color to be used when plotting this material.
 ; list, all, bulk
 : The list option will list all of the currently defined materials in the active structure.  All will list all materials that have been defined, even if they ar not currently present.  Bulk modifies both of the previous options to list bulk materials only and not interfaces.
@@ Line 27: / Line 32: @@
 == Examples ==
-  mater name=Potential damp negative solve add
+  mater name=Silicon green alias=Si
-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.
+Create a material name Silicon with an alias of Si and set the default color to green.
+ mater list
-== See Also ==
+Return a list of all materials in the current structure.
-[tutorials.htm language tutorials], [language.htm language definition], [callback.htm callback procedures], [eqn.htm eqn], [solutions.htm solution], [examples.htm Alagator Examples]
+ mater list bulk
-[../Intro.html FLOOPS/FLOODS Home Page]
+Return a list of all bull materials in the current structure.

MaterCommand: Difference between revisions