Inlets outlets¶
Commands of the inlets_outlets chapter of the database, 7 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.
CREATE_NEW_INLET¶
Phase setup, layout inline. Manual: SRC-003 p.325.
Marks one mesh boundary as an inlet with a uniform velocity along the surface normal of its faces. The manual states the index must be greater than zero and states no all-form, so -1 is not accepted here. THE SIGN CONVENTION IS THE FACE NORMAL AND NOT THE FLOW DIRECTION. The manual says the velocity is applied along the surface normal vector, so whether a positive value draws flow in or blows it out depends on which way the boundary's normals point, which is a property of the imported mesh. No edition states which sign means ingestion, and nothing here can check it.
| Argument | Specification |
|---|---|
surface_id |
int |
velocity |
float [simulation velocity units] |
| Version | Status | Evidence |
|---|---|---|
| 25.000 | documented | SRC-749 p.283, same grammar as 26.120 |
| 25.100 | documented | SRC-748 p.300, same grammar as 26.120 |
| 26.000 | documented | SRC-747 p.299, same grammar as 26.120 |
| 26.100 | documented | SRC-741 p.321, same grammar as 26.120 |
| 26.101 | documented | SRC-725 p.324, same grammar as 26.120 |
| 26.120 | documented | SRC-003 p.325 |
| 26.121 | documented | SRC-740 p.328, same grammar as 26.120 |
| 26.123 | documented | SRC-751 p.330, unchanged from SRC-750 p.330 |
| 26.124 | documented | SRC-752 p.330, the SRC-751 file, carried from 26.123; not run on 26.124 |
CREATE_NEW_OUTLET¶
Phase setup, layout inline. Manual: SRC-003 pp.325-326.
Marks one mesh boundary as an outlet with a uniform normal velocity. Always uniform: there is no outlet profile command. The table's description of VELOCITY is copied from the inlet and names the inlet faces, in the four editions read then. Cosmetic. THE OUTLET THIS CREATES IS THE ONE THE NEWEST EDITION TELLS A USER TO MARK AS AN EXHAUST OUTFLOW, so the reading of that feature sits here as well as in the chapter header. SRC-751 p.191 documents the perimeter of an outlet being markable so the solver sheds a wake from it and accounts for its interaction with the surrounding flow. There is no command for it in that edition's scripting reference, so this entry creates the boundary and nothing here can then mark it. A QUESTION FOR THE VENDOR, NOT A PARAPHRASE OF GUIDANCE: that paragraph instructs the reader to right-click an INLET inside the Outlets node. Taken literally it names the wrong node's children, and every other noun in the paragraph is an outlet, so the sentence reads as copied from the inlet section above it. It is recorded because it is the third instance of that copy in this chapter, the other two being this entry's own velocity description and DELETE_OUTLET's parameter row, and because a reader following it literally would look in the wrong place. Nothing here rests on it and it is not restated as an instruction.
| Argument | Specification |
|---|---|
surface_id |
int |
velocity |
float [simulation velocity units] |
| Version | Status | Evidence |
|---|---|---|
| 26.100 | documented | SRC-741 pp.321-322, same grammar as 26.120 |
| 26.101 | documented | SRC-725 pp.324-325, same grammar as 26.120 |
| 26.120 | documented | SRC-003 pp.325-326 |
| 26.121 | documented | SRC-740 pp.328-329, same grammar as 26.120 |
| 26.123 | documented | SRC-751 p.330, unchanged from SRC-750 p.330 |
| 26.124 | documented | SRC-752 p.330, the SRC-751 file, carried from 26.123; not run on 26.124 |
DELETE_INLET¶
Phase setup, layout inline. Manual: SRC-003 p.325.
Unmarks one inlet. No all-form is stated and there is no delete-all command, so removing several takes one call each. The signature heading spells the placeholder INDEX and the table row spells it INLET; the table's is used, being the one that says what the index is of.
| Argument | Specification |
|---|---|
inlet |
int |
| Version | Status | Evidence |
|---|---|---|
| 25.000 | documented | SRC-749 p.283, same grammar as 26.120 |
| 25.100 | documented | SRC-748 p.300, same grammar as 26.120 |
| 26.000 | documented | SRC-747 p.299, same grammar as 26.120 |
| 26.100 | documented | SRC-741 p.321, same grammar as 26.120 |
| 26.101 | documented | SRC-725 p.324, same grammar as 26.120 |
| 26.120 | documented | SRC-003 p.325 |
| 26.121 | documented | SRC-740 p.328, same grammar as 26.120 |
| 26.123 | documented | SRC-751 p.330, unchanged from SRC-750 p.330 |
| 26.124 | documented | SRC-752 p.330, the SRC-751 file, carried from 26.123; not run on 26.124 |
DELETE_OUTLET¶
Phase setup, layout inline. Manual: SRC-003 p.326.
Unmarks one outlet. Its table row is labelled INLET in all four editions, which is the copy that runs through this chapter; the argument is named for what the command deletes.
| Argument | Specification |
|---|---|
outlet |
int |
| Version | Status | Evidence |
|---|---|---|
| 26.100 | documented | SRC-741 p.322, same grammar as 26.120 |
| 26.101 | documented | SRC-725 p.325, same grammar as 26.120 |
| 26.120 | documented | SRC-003 p.326 |
| 26.121 | documented | SRC-740 p.329, same grammar as 26.120 |
| 26.123 | documented | SRC-751 p.331, unchanged from SRC-750 p.331 |
| 26.124 | documented | SRC-752 p.331, the SRC-751 file, carried from 26.123; not run on 26.124 |
REMESH_INLET¶
Phase geometry, layout keyword_block. Manual: SRC-003 p.325.
Rebuilds an inlet's faces as a radial distribution. The manual gives no reason for wanting one and none is asserted here; what the page does state is that the inlet velocity is applied along the surface normal of its FACES, so the face layout is what a prescribed profile is resolved on. Phase is geometry, this being a mesh operation rather than a labelling one. Line for line the same block as REMESH_BASE_REGION and REMESH_OUTLET, including the numeric GROWTH_SCHEME, 1 for successive and 2 for dual-sided, where the CCS chapters spell the same two schemes as words. INNER_RADIUS takes 0.0 for no inner radius, which the manual glosses as a disk inlet rather than an annular one.
| Argument | Specification |
|---|---|
inlet |
int |
inner_radius |
float [simulation length units] |
elements |
int |
growth_scheme |
enum in |
growth_rate |
float |
| Version | Status | Evidence |
|---|---|---|
| 25.000 | documented | SRC-749 p.283, same grammar as 26.120 |
| 25.100 | documented | SRC-748 p.300, same grammar as 26.120 |
| 26.000 | documented | SRC-747 p.299, same grammar as 26.120 |
| 26.100 | documented | SRC-741 p.321, same grammar as 26.120 |
| 26.101 | documented | SRC-725 p.324, same grammar as 26.120 |
| 26.120 | documented | SRC-003 p.325 |
| 26.121 | documented | SRC-740 p.328, same grammar as 26.120 |
| 26.123 | documented | SRC-751 p.330, unchanged from SRC-750 p.330 |
| 26.124 | documented | SRC-752 p.330, the SRC-751 file, carried from 26.123; not run on 26.124 |
REMESH_OUTLET¶
Phase geometry, layout keyword_block. Manual: SRC-003 p.326.
The outlet counterpart of REMESH_INLET, differing only in the name of its first keyword.
| Argument | Specification |
|---|---|
outlet |
int |
inner_radius |
float [simulation length units] |
elements |
int |
growth_scheme |
enum in |
growth_rate |
float |
| Version | Status | Evidence |
|---|---|---|
| 26.100 | documented | SRC-741 p.322, same grammar as 26.120 |
| 26.101 | documented | SRC-725 p.325, same grammar as 26.120 |
| 26.120 | documented | SRC-003 p.326 |
| 26.121 | documented | SRC-740 p.329, same grammar as 26.120 |
| 26.123 | documented | SRC-751 p.331, unchanged from SRC-750 p.331 |
| 26.124 | documented | SRC-752 p.331, the SRC-751 file, carried from 26.123; not run on 26.124 |
SET_INLET_CUSTOM_PROFILE¶
Phase setup, layout inline. Manual: SRC-003 p.325.
Replaces an inlet's uniform velocity with a profile read from a text file, whose path follows on the next line. Has no outlet counterpart in any edition. The parameter table calls the file's content motion data, which is the description of a different command's file; what this one reads is a velocity profile, as the command name and the sample comment both say. Noted rather than acted on, since nothing here validates the file.
| Argument | Specification |
|---|---|
inlet_id |
int |
file |
path |
| Version | Status | Evidence |
|---|---|---|
| 25.000 | documented | SRC-749 p.283, same grammar as 26.120 |
| 25.100 | documented | SRC-748 p.300, same grammar as 26.120 |
| 26.000 | documented | SRC-747 p.299, same grammar as 26.120 |
| 26.100 | documented | SRC-741 p.321, same grammar as 26.120 |
| 26.101 | documented | SRC-725 p.324, same grammar as 26.120 |
| 26.120 | documented | SRC-003 p.325 |
| 26.121 | documented | SRC-740 p.328, same grammar as 26.120 |
| 26.123 | documented | SRC-751 p.330, unchanged from SRC-750 p.330 |
| 26.124 | documented | SRC-752 p.330, the SRC-751 file, carried from 26.123; not run on 26.124 |