Declarations
A .fea module is a list of imports followed by top-level declarations. This page lists every declaration, every member it accepts, the member's type and unit, whether it is required, and its default. Blocks marked fragment show the shape of one declaration, not a whole file. A complete study is on the language overview.
Units are written after the number (2 mm, 200 GPa, 7850 kg/m^3); any unit of the right dimension is accepted, and the units table lists the spellings. "Number" means a dimensionless value written without a unit.
Imports
import geometry bracket from "./geometry/bracket.fea"
import model mounting from "./models/mounting.fea"
import function impact_pulse from "./impact_pulse.m"import <kind> <name> from "<path>" binds one declaration of one kind from another file. The kinds are geometry, mesh, material, model, study, sweep, execution and function; a function import names one .m file. Imports come before local declarations, name exactly one symbol, and re-export nothing. Paths are relative to the importing file. Missing symbols, a symbol of the wrong kind, import cycles and paths outside the project are check errors. See files, modules and imports.
geometry
geometry bracket {
file = "./geometry/bracket.step"
units = mm
interfaces = shared
region body : solid { select name "Body"; expect exactly_one }
region bolt_faces : face { select tag "BOLT_HOLES"; expect one_or_more }
}A geometry has exactly one source:
| Source form | Meaning |
|---|---|
file = "<path>" | Import a CAD file: STEP (.step, .stp, including AP242), IGES (.iges, .igs) or OpenCASCADE BREP (.brep). |
construct { … } | Build the solid from features (box, cylinder, sphere, extrude, revolve, union, subtract, intersect, hole, pocket, fillet, chamfer, transform, instance). See geometry features and AP242. |
generated by function.<name> { arguments { … } } | Call an imported .m function that returns geometry. See RunMat function integration. |
geometry <name> from geometry.<source> { derive { … } } | Regenerate another geometry with changed CAD parameters: derive { set source.parameter.<p> = <value>; result = regenerate(source) }. |
Members:
| Member | Type | Required | Default | Meaning |
|---|---|---|---|---|
units | mm, m or in | When the file carries no length unit | the file's own unit | Length unit for a CAD file that states none. A file that carries its unit (STEP does) needs no units; when present, it must agree. |
interfaces | shared or separate | no | separate | shared joins touching bodies so their coincident faces become one shared face and the mesh is conformal across them. separate keeps each body's faces. |
input <name> : <type> = <default> | typed input | no | A geometry parameter, such as a hole radius used by construct. | |
cad_parameter <name> : <type> { select persistent_id "…"; require readable | writable } | CAD parameter | no | A named parameter read from the CAD file (geometry.<g>.parameter.<name>) and, when writable, set in a derive block. | |
region <name> : <role> { … } | region | no | A named selection. Roles: solid, face, edge, vertex and cell. |
Region bodies hold one selector and an optional cardinality check:
| Statement | Selects |
|---|---|
select name "<label>" | Entities whose name is authored in the CAD file (STEP or IGES labels). |
select tag "<layer>" | Entities on a CAD presentation layer. |
select persistent_id "persistent-entity:sha256:…" (also select id) | One entity by its canonical persistent id. |
select result | The result of a construct or generated by source. |
select feature.<f> | The body a construction feature produced. |
select boundary_introduced_by feature.<f> | The faces a feature created, such as the wall of a hole. |
select output.region.<r> | A region returned by a geometry-generating function. |
| geometric predicates (planar faces by normal, faces within a box) Not yet releasedStatus | Faces or edges chosen by a bounded geometric test, with cardinality and stability evidence. |
expect exactly_one / expect one_or_more | Fails the check when the selection does not have that cardinality. |
Region names resolve once, at the CAD boundary, to canonical persistent ids; inside the solver every region is matched by id. A study references a region as geometry.<g>.region.<r>.
mesh
mesh bracket on geometry.bracket {
tetrahedra {
order = quadratic
target_size = 2 mm
maximum_deviation = 0.05 mm
cells_across_gap = 2
refine fillets {
on = geometry.bracket.region.fillet_faces
target_size = 0.5 mm
}
}
}mesh <name> on geometry.<g> { <element block> } requests one mesh of one geometry. A study can use the mesh only with that geometry. The element block names the elements:
| Block | Elements | Used for |
|---|---|---|
tetrahedra | Tet4 (order = linear) or Tet10 (order = quadratic) | Solids. |
triangles | Shell triangles, with the sheet's edges as segments | Shells on sheet faces. |
lines | Two-node segments | Beams on edges. |
A mesh without an element block requests linear tetrahedra with the defaults below. At most one block is allowed.
| Member | Type | Blocks | Default | Meaning |
|---|---|---|---|---|
order | linear or quadratic | tetrahedra | linear | Element order. |
target_size | length | all | 10 mm | Target element edge length. |
maximum_deviation | length | all | 0.1 mm | Largest allowed distance between the mesh and the CAD surface. |
maximum_grading_ratio | number > 1 | all | 1.3 | Largest size ratio between neighboring element layers. |
deterministic_seed | integer | all | 0 | Seed for the mesher's deterministic choices; the same seed gives the same mesh. |
cells_across_gap | integer 1–64 | tetrahedra | none | Elements through gaps and walls thinner than this count times target_size. |
refine <name> { on = <region>; target_size = <length> } | block, any number | tetrahedra | none | A smaller local size on a solid, face or edge region of the meshed geometry. |
Where sizes overlap, the smallest wins, in any order. Away from a refined region the size grows back at maximum_grading_ratio per layer. See meshing.
material
material steel {
mass_density = 7850 kg/m^3
elastic {
youngs_modulus = 200 GPa
poisson_ratio = 0.3
}
thermal {
conductivity = 45 W/m/K
specific_heat = 460 J/kg/K
expansion_coefficient = 12e-6 K^-1
reference_temperature = 293.15 K
modulus_temperature_coefficient = 0 K^-1
}
rayleigh_damping {
mass_coefficient = 0.2 Hz
stiffness_coefficient = 20 us
}
}A material is a name plus capability blocks. Each block is optional; a study's physics family requires the blocks it uses (a structural step needs mass_density and elastic or orthotropic_lamina; a thermal step needs thermal). Inside a block, every listed member is required unless the table says otherwise.
| Block or member | Members (type) | Meaning |
|---|---|---|
name | string | Display name, such as the catalog grade. |
mass_density | density | Mass per unit volume. |
elastic | youngs_modulus (pressure), poisson_ratio (number) | Isotropic linear elasticity. |
orthotropic_lamina | longitudinal_modulus, transverse_modulus, in_plane_shear_modulus, transverse_shear_modulus_13, transverse_shear_modulus_23 (pressure); major_poisson_ratio (number) | A unidirectional ply for composite layups. |
plastic | law = j2_isotropic_linear_hardening Not yet releasedStatus, yield_stress (pressure), isotropic_hardening_modulus (pressure) | Von Mises (J2) plasticity with linear isotropic hardening, for structural nonlinear steps. |
rayleigh_damping | mass_coefficient (1/time, written in Hz), stiffness_coefficient (time) | . |
thermal | conductivity (W/m/K), specific_heat (J/kg/K), expansion_coefficient (1/temperature), reference_temperature (temperature), modulus_temperature_coefficient (1/temperature) | Heat conduction and storage, thermal strain from the reference temperature, and a linear temperature dependence of the elastic modulus. |
electrical | conductivity (electrical conductivity, written A/V/m), relative_permittivity (number), relative_permeability (number), resistive_heating_coefficient (1/temperature), reference_temperature (temperature) | Conduction, permittivity and permeability for electromagnetic families; a linear temperature dependence of resistivity for electrothermal coupling. |
acoustic | speed_of_sound (velocity), damping_ratio (number) | An acoustic medium; density is mass_density. |
fluid | law plus the law's members | Incompressible flow: incompressible_newtonian (dynamic_viscosity), and the generalized-Newtonian laws power_law, carreau, carreau_yasuda, cross, bingham, herschel_bulkley and casson. |
porous | law = darcy or darcy_forchheimer, permeability (area), porosity (number), inertial_coefficient (number, Darcy–Forchheimer) | Flow through a porous region. |
The members of each fluid law are listed in fluid materials. A material can also come from the CAD file: material <name> from geometry.<g>.cad_material("<name>") { use …; require operating_temperature; on_conflict = reject } reads a material authored in an AP242 file, and the study states which properties it uses. See geometry features and AP242.
model
model mounting(region body : region<solid>, region base : region<face>) {
input body_material : material
assign input.body_material to input.body
constraint support {
structural.fixed { target = input.base }
}
}model <name> { … } holds the physical description: what material is where, and what acts on it. A model can take typed parameters in parentheses (regions, materials and quantities), which a study binds by name: model = model.mounting(body_material = material.steel, body = geometry.part.region.body, base = geometry.part.region.base).
| Member | Form | Meaning |
|---|---|---|
input | input <name> : <type> | A model input bound by the study. |
include | include model.<other> | Adds another model's declarations. Binding the included model's own inputs by name, include model.<other>(<name> = <value>, …) Not yet releasedStatus. |
assign | assign material.<m> to <region> | Gives a region its material. Every meshed solid needs exactly one. |
| sections and layups | section, layup, orientation | Beam and shell sections, composite layups and material orientations. See models. |
constraint <name> { <kind> { … } } | constraint | Supports, prescribed values, symmetry, periodic pairs and equations. See constraints. |
load <name> { … } | load | Forces, pressures, tractions, body loads, heat loads, currents and acoustic or flow sources. See loads. |
load_case <name> { include load.<l>; … } | load case | A named group of loads that analysis steps select. |
signal <name> : <quantity> over <domain> { … } | signal | A value over time, frequency or a parameter: constant, waveform, table or generated by a .m function. |
excitation <name> { … } | excitation | Drives a load with a signal. |
response_spectrum, random_excitation | spectral input | Design spectra and power spectral densities for spectrum and random-response steps. |
interface <name> { … } | interface | Bonded and contact interfaces, and coupled-family interfaces. See interfaces. |
connector <name> { … } | connector | Springs, dampers and point masses between regions. See connectors. |
initial <name> { … } | initial condition | Initial temperature, displacement, velocity and other state. See initial conditions. |
A model has no defaults block: what it must contain is decided by the analysis steps that use it. The exact fields of every constraint, load and interface kind are on constraints, loads and interfaces.
study
study bracket_static {
geometry = geometry.bracket
mesh = mesh.bracket
model = model.loaded_bracket
execution = execution.workstation
input service_load : force = 1.0 kN
analysis static { structural static {} }
output fillet_stress = max(analysis.static.field.node.von_mises_stress, over = geometry.bracket.region.fillets)
assessment stress_allowable {
value = output.fillet_stress
maximum = 250 MPa
evidence = authored_samples
}
}| Member | Form | Required | Meaning |
|---|---|---|---|
geometry | geometry.<g> | yes | The geometry. |
mesh | mesh.<m> | yes | A mesh of that geometry. |
model | model.<m> or model.<m>(<bindings>) | yes | The physical model, with its parameters bound. |
execution | execution.<e> | no | Placement and resources; omitted means the local machine with automatic settings. |
input | input <name> : <type> = <default> or a block with default, minimum, maximum | no | A study input that sweeps and the command line can set. See inputs, sweeps and cases. |
analysis | analysis <name> { <family> <procedure> { … } }, optionally after <step> | at least one | An analysis step. See studies, analyses and state and the procedure reference. |
output | output <name> = <expression> | no | A published field or reduced quantity. See outputs, fields and observations. |
assessment | assessment <name> { value; minimum and/or maximum; evidence } | no | A pass or fail verdict on an output. See operations and output queries. |
sweep
sweep envelope over study.bracket_response {
axis service_load {
half = 0.5 kN
nominal = 1.0 kN
}
axis damping {
low = 0.01
high = 0.02
}
combine = product
}sweep <name> over study.<s> { … } declares named cases of the study's inputs, either as axis blocks (each a set of named values for one input) or as explicit case blocks (each binding several inputs). A sweep uses axes or cases, never both.
| Member | Form | Default | Meaning |
|---|---|---|---|
axis <input> { <label> = <value>; … } | axis | The values one input takes. | |
combine | product or zip | product | Cartesian product of the axes, or element by element (axes of equal length). |
case <name> { <input> = <value>; … } | case | One explicit case. | |
output | output <name> = collect(…), retain_each(…), case min/max | Results across cases. |
execution
execution cluster {
placement = cluster
backend = auto
resources {
workers = 4..32
cpu_threads_per_worker = 8
memory_per_worker <= 32 GiB
accelerators = preferred
}
fanout { sweep_cases = auto; frequency_samples = auto }
cooperative { operator_partitions = auto; partitioner = graph; balance = nonzeros }
resilience { retries = 2; checkpoint = automatic }
}Every member is optional; a study without execution runs locally with the defaults.
| Member | Values | Default | Meaning |
|---|---|---|---|
placement | auto, local, cluster, profile.<name> | auto | Where the work runs; a profile names a configured cluster. |
backend | auto, cpu, accelerator | auto | Preferred numerical backend. |
resources.workers | N or N..M | automatic | Worker count or range. |
resources.cpu_threads_per_worker | N or N..M | automatic | Threads per worker. |
resources.memory_per_worker | <= <bytes> | automatic | Memory ceiling per worker (32 GiB). |
resources.accelerators | disabled, preferred, required | disabled | GPU use. preferred falls back to the CPU reference path with a diagnostic when the GPU can't run a step; required fails instead. |
fanout.sweep_cases | auto or a positive integer | auto | Sweep cases run in parallel. |
fanout.frequency_samples | auto or a positive integer | auto | Frequency samples run in parallel. |
cooperative.operator_partitions | auto or a positive integer | auto | Partitions of one operator across workers (domain decomposition). |
cooperative.partitioner | auto, graph, geometric | auto | How the mesh is partitioned. |
cooperative.balance | nonzeros, dofs, elements | nonzeros | What the partitions balance. |
resilience.retries | integer ≥ 0 | 0 | Retries of a failed work item. |
resilience.checkpoint | disabled, automatic, required | automatic | Durable checkpoints for long steps. |
See execution, parallel work and distributed work.
table
table ceiling_tile : impedance over frequency {
model = delany_bazley
flow_resistivity = 20000 Pa*s/m^2
thickness = 50 mm
}table <name> : impedance over frequency { … } declares a frequency-dependent acoustic surface impedance that boundaries reference as table.<name>. It is either measured samples or a porous-layer model:
| Form | Members | Meaning |
|---|---|---|
| Samples | samples = [{ at = <frequency>, resistance = <Pa*s/m>, reactance = <Pa*s/m> }, …] | Measured impedance, interpolated linearly in frequency and held constant beyond the end samples. |
| Delany–Bazley | model = delany_bazley, flow_resistivity (Pa·s/m²), thickness (length) | A rigidly backed porous layer. |
See acoustic loads.