Mesh wrapper¶
Commands of the mesh_wrapper chapter of the database, 11 entries. The status words are defined once, on the compatibility matrix, which says what each rests on and what the script builder does with it. Read it before this page: broken and removed are refusals, so a row here can be telling you the emitter will not write that command for that version.
WRAPPER_CREATE_LOCAL_CONTROL¶
Phase geometry, layout bare. Manual: SRC-003 p.314.
Appends an empty local control, which is then configured by WRAPPER_EDIT_LOCAL_CONTROL. It takes nothing and reports nothing, so the id to edit is the number of controls created so far and the caller has to keep that count itself.
| Version | Status | Evidence |
|---|---|---|
| 25.000 | documented | SRC-749 p.269, same grammar as 26.120 |
| 25.100 | documented | SRC-748 p.288, same grammar as 26.120 |
| 26.000 | documented | SRC-747 p.287, same grammar as 26.120 |
| 26.100 | documented | SRC-741 p.309, same grammar as 26.120 |
| 26.101 | documented | SRC-725 p.313, same grammar as 26.120 |
| 26.120 | documented | SRC-003 p.314 |
| 26.121 | documented | SRC-740 p.317, same grammar as 26.120 |
| 26.123 | documented | SRC-751 p.318, unchanged from SRC-750 p.318 |
| 26.124 | documented | SRC-752 p.318, the SRC-751 file, carried from 26.123; not run on 26.124 |
WRAPPER_DELETE_ALL_LOCAL_CONTROLS¶
Phase geometry, layout bare. Manual: SRC-003 pp.314-315.
Deletes every local control. There is no command deleting one, so correcting a single control means deleting all of them and building the set again.
| Version | Status | Evidence |
|---|---|---|
| 25.000 | documented | SRC-749 p.270, same grammar as 26.120 |
| 25.100 | documented | SRC-748 p.289, same grammar as 26.120 |
| 26.000 | documented | SRC-747 p.288, same grammar as 26.120 |
| 26.100 | documented | SRC-741 p.310, same grammar as 26.120 |
| 26.101 | documented | SRC-725 p.313, same grammar as 26.120 |
| 26.120 | documented | SRC-003 pp.314-315 |
| 26.121 | documented | SRC-740 p.317, same grammar as 26.120 |
| 26.123 | documented | SRC-751 p.318, unchanged from SRC-750 p.318 |
| 26.124 | documented | SRC-752 p.318, the SRC-751 file, carried from 26.123; not run on 26.124 |
WRAPPER_DELETE_ALL_VOLUME_CONTROLS¶
Phase geometry, layout bare. Manual: SRC-003 p.315.
Deletes every volume control, and as with the local controls there is no command deleting one.
| Version | Status | Evidence |
|---|---|---|
| 25.000 | documented | SRC-749 p.270, same grammar as 26.120 |
| 25.100 | documented | SRC-748 p.289, same grammar as 26.120 |
| 26.000 | documented | SRC-747 p.288, same grammar as 26.120 |
| 26.100 | documented | SRC-741 p.310, same grammar as 26.120 |
| 26.101 | documented | SRC-725 p.314, same grammar as 26.120 |
| 26.120 | documented | SRC-003 p.315 |
| 26.121 | documented | SRC-740 p.318, same grammar as 26.120 |
| 26.123 | documented | SRC-751 p.319, unchanged from SRC-750 p.319 |
| 26.124 | documented | SRC-752 p.319, the SRC-751 file, carried from 26.123; not run on 26.124 |
WRAPPER_EDIT_LOCAL_CONTROL¶
Phase geometry, layout keyword_block. Manual: SRC-003 p.314.
Gives one local control the surfaces it applies to and the cell size it asks for there, overriding the global size on those surfaces. The surface list repeats the count-then-indices shape of WRAPPER_SET_INPUT, but inside the keyword block: SURFACES carries the count and the indices follow on the next line, comma separated, exactly as in SURFACE_ROTATE. CONTROL_ID is 1-based and is not declared as a citation, because a local control is not an entity the script builder tracks: nothing creates one with a name, so there is no inventory to resolve against and nothing to range check.
| Argument | Specification |
|---|---|
control_id |
int |
surfaces |
int |
surface_indices |
int_list |
target_size |
float [simulation length units] |
| Version | Status | Evidence |
|---|---|---|
| 25.000 | documented | SRC-749 p.270, same grammar as 26.120 |
| 25.100 | documented | SRC-748 p.288, same grammar as 26.120 |
| 26.000 | documented | SRC-747 p.287, same grammar as 26.120 |
| 26.100 | documented | SRC-741 p.309, same grammar as 26.120 |
| 26.101 | documented | SRC-725 p.313, same grammar as 26.120 |
| 26.120 | documented | SRC-003 p.314 |
| 26.121 | documented | SRC-740 p.317, same grammar as 26.120 |
| 26.123 | documented | SRC-751 p.318, unchanged from SRC-750 p.318 |
| 26.124 | documented | SRC-752 p.318, the SRC-751 file, carried from 26.123; not run on 26.124 |
WRAPPER_EXECUTE¶
Phase geometry, layout bare. Manual: SRC-003 p.315.
Performs the wrap with everything configured above. The one command in the chapter that does work rather than describing it, and the only one whose cost is more than negligible.
| Version | Status | Evidence |
|---|---|---|
| 25.000 | documented | SRC-749 p.270, same grammar as 26.120 |
| 25.100 | documented | SRC-748 p.289, same grammar as 26.120 |
| 26.000 | documented | SRC-747 p.288, same grammar as 26.120 |
| 26.100 | documented | SRC-741 p.310, same grammar as 26.120 |
| 26.101 | documented | SRC-725 p.314, same grammar as 26.120 |
| 26.120 | documented | SRC-003 p.315 |
| 26.121 | documented | SRC-740 p.318, same grammar as 26.120 |
| 26.123 | documented | SRC-751 p.319, unchanged from SRC-750 p.319 |
| 26.124 | documented | SRC-752 p.319, the SRC-751 file, carried from 26.123; not run on 26.124 |
WRAPPER_NEW_VOLUME_CONTROL¶
Phase geometry, layout keyword_block. Manual: SRC-003 p.315.
Creates a box in which the wrap uses a different cell size, given by two opposite corners in a coordinate system. Unlike a local control, which is created empty and then edited, a volume control is created already configured and can afterwards only be deleted. FRAME is a coordinate system index and the manual states that the reference frame is 1, which is the same convention as the rest of the database, so it is declared as citing a frame. The two corners are named VERTEX_1 and VERTEX_2 and the manual gives no ordering rule between them, so which corner is which is the caller's choice as far as any edition states.
| Argument | Specification |
|---|---|
frame |
int |
vertex_1 |
float |
vertex_1_y |
float |
vertex_1_z |
float |
vertex_2 |
float |
vertex_2_y |
float |
vertex_2_z |
float |
target_size |
float [simulation length units] |
name |
str |
| Version | Status | Evidence |
|---|---|---|
| 25.000 | documented | SRC-749 p.270, same grammar as 26.120 |
| 25.100 | documented | SRC-748 p.289, same grammar as 26.120 |
| 26.000 | documented | SRC-747 p.288, same grammar as 26.120 |
| 26.100 | documented | SRC-741 p.310, same grammar as 26.120 |
| 26.101 | documented | SRC-725 p.314, same grammar as 26.120 |
| 26.120 | documented | SRC-003 p.315 |
| 26.121 | documented | SRC-740 p.318, same grammar as 26.120 |
| 26.123 | documented | SRC-751 p.319, unchanged from SRC-750 p.319 |
| 26.124 | documented | SRC-752 p.319, the SRC-751 file, carried from 26.123; not run on 26.124 |
WRAPPER_SET_ANISOTROPY¶
Phase geometry, layout inline. Manual: SRC-003 p.314.
Stretches the target cell size per axis, so 2 1 1 asks for cells twice as long in X as in the other two directions. The three are ratios rather than lengths, the length being WRAPPER_SET_GLOBAL_SIZE's subject. The manual states no reference frame for these axes and no edition names one, so which frame they are read in is unrecorded rather than assumed to be the global one.
| Argument | Specification |
|---|---|
x |
float |
y |
float |
z |
float |
| Version | Status | Evidence |
|---|---|---|
| 25.000 | documented | SRC-749 p.269, same grammar as 26.120 |
| 25.100 | documented | SRC-748 p.288, same grammar as 26.120 |
| 26.000 | documented | SRC-747 p.287, same grammar as 26.120 |
| 26.100 | documented | SRC-741 p.309, same grammar as 26.120 |
| 26.101 | documented | SRC-725 p.313, same grammar as 26.120 |
| 26.120 | documented | SRC-003 p.314 |
| 26.121 | documented | SRC-740 p.317, same grammar as 26.120 |
| 26.123 | documented | SRC-751 p.318, unchanged from SRC-750 p.318 |
| 26.124 | documented | SRC-752 p.318, the SRC-751 file, carried from 26.123; not run on 26.124 |
WRAPPER_SET_GLOBAL_SIZE¶
Phase geometry, layout inline. Manual: SRC-003 p.314.
Target triangle edge length of the wrapped mesh, everywhere no local or volume control overrides it. The manual states the value must be greater than zero and the bound is not enforced here.
| Argument | Specification |
|---|---|
target_size |
float [simulation length units] |
| Version | Status | Evidence |
|---|---|---|
| 25.000 | documented | SRC-749 p.269, same grammar as 26.120 |
| 25.100 | documented | SRC-748 p.288, same grammar as 26.120 |
| 26.000 | documented | SRC-747 p.287, same grammar as 26.120 |
| 26.100 | documented | SRC-741 p.309, same grammar as 26.120 |
| 26.101 | documented | SRC-725 p.313, same grammar as 26.120 |
| 26.120 | documented | SRC-003 p.314 |
| 26.121 | documented | SRC-740 p.317, same grammar as 26.120 |
| 26.123 | documented | SRC-751 p.318, unchanged from SRC-750 p.318 |
| 26.124 | documented | SRC-752 p.318, the SRC-751 file, carried from 26.123; not run on 26.124 |
WRAPPER_SET_INPUT¶
Phase geometry, layout payload_lines. Manual: SRC-003 p.314.
Chooses which surfaces the wrap is built over: the count on the command line and the indices comma separated on the next, the same shape as SURFACE_COMBINE. The manual gives the second row no parameter name at all, printing N/A in that column and describing it in prose, so the name here is this database's.
| Argument | Specification |
|---|---|
num_surfaces |
int |
surface_indices |
int_list |
| Version | Status | Evidence |
|---|---|---|
| 25.000 | documented | SRC-749 p.269, same grammar as 26.120 |
| 25.100 | documented | SRC-748 p.288, same grammar as 26.120 |
| 26.000 | documented | SRC-747 p.287, same grammar as 26.120 |
| 26.100 | documented | SRC-741 p.309, same grammar as 26.120 |
| 26.101 | documented | SRC-725 p.313, same grammar as 26.120 |
| 26.120 | documented | SRC-003 p.314 |
| 26.121 | documented | SRC-740 p.317, same grammar as 26.120 |
| 26.123 | documented | SRC-751 p.318, unchanged from SRC-750 p.318 |
| 26.124 | documented | SRC-752 p.318, the SRC-751 file, carried from 26.123; not run on 26.124 |
WRAPPER_SET_VERTEX_PROJECTION¶
Phase geometry, layout inline. Manual: SRC-003 p.314.
Whether the wrapped mesh's vertices are projected back onto the input surfaces, which keeps sharp features the wrap would otherwise round off. The manual has no name for this argument: the signature placeholder IS the pair of values, and the parameter table repeats the pair in its name column. The database spells such an argument
mode, which is its house name for a two-valued switch, so this is one of the places the entry is the better document.
| Argument | Specification |
|---|---|
mode |
enum in |
| Version | Status | Evidence |
|---|---|---|
| 25.000 | documented | SRC-749 p.269, same grammar as 26.120 |
| 25.100 | documented | SRC-748 p.288, same grammar as 26.120 |
| 26.000 | documented | SRC-747 p.287, same grammar as 26.120 |
| 26.100 | documented | SRC-741 p.309, same grammar as 26.120 |
| 26.101 | documented | SRC-725 p.313, same grammar as 26.120 |
| 26.120 | documented | SRC-003 p.314 |
| 26.121 | documented | SRC-740 p.317, same grammar as 26.120 |
| 26.123 | documented | SRC-751 p.318, unchanged from SRC-750 p.318 |
| 26.124 | documented | SRC-752 p.318, the SRC-751 file, carried from 26.123; not run on 26.124 |
WRAPPER_TRANSFER¶
Phase geometry, layout inline. Manual: SRC-003 p.315.
Moves the wrapped result into the simulation as geometry, and decides what becomes of the surfaces it was built from: REPLACE deletes them, RETAIN keeps them alongside the wrap. REPLACE IS DESTRUCTIVE AND CHANGES EVERY SURFACE INDEX AFTER IT. The input surfaces cease to exist and the wrap takes their place, so an index recorded before this call means something else afterwards. Nothing here can enforce that, the builder having no view of the solver's boundary list, so it is stated where a reader meets the command.
| Argument | Specification |
|---|---|
source_treatment |
enum in |
| Version | Status | Evidence |
|---|---|---|
| 25.000 | documented | SRC-749 p.271, same grammar as 26.120 |
| 25.100 | documented | SRC-748 p.289, same grammar as 26.120 |
| 26.000 | documented | SRC-747 p.288, same grammar as 26.120 |
| 26.100 | documented | SRC-741 p.310, same grammar as 26.120 |
| 26.101 | documented | SRC-725 p.314, same grammar as 26.120 |
| 26.120 | documented | SRC-003 p.315 |
| 26.121 | documented | SRC-740 p.318, same grammar as 26.120 |
| 26.123 | documented | SRC-751 p.319, unchanged from SRC-750 p.319 |
| 26.124 | documented | SRC-752 p.319, the SRC-751 file, carried from 26.123; not run on 26.124 |