Skip to content

Error codes of the model document (beta)

Most findings about a model document (a design with a physics section) carry a code: a stable identifier of the form area.problem, for programs and assistants to act on, beside the message, the JSON pointer and the hint that people read. This page lists every code of the model path. A few findings carry no code, and for them the message, the pointer and the hint are all there is: the ones that an electromagnetic design can also have (a required field that is missing, a field that does not exist, a value of the wrong type or out of its range), an expression that cannot be read or evaluated, an unknown value of symmetry, of a study type, of a coupling strategy or of a continuation scale, and an internal failure of the validation. Model documents are beta: this version validates a model document (axmp validate, Design.validate()), resolves its geometry (axmp resolve), explains it (axmp explain), patches it (axmp patch), lists and checks its named boundaries (axmp boundaries) and meshes a planar or axisymmetric one (axmp mesh, axmp.mesh); it solves none (no route is implemented), so a code may still be renamed. Some codes are raised for electromagnetic designs too: model.section_needs_physics (a section of a model document in a design without physics), the refusals of an arc path (geometry.arc_span, geometry.arc_degenerate, geometry.arc_negative_r) and mesh.tangled, when a 2D mesh with a tangled curved element is read.

A finding has one of four kinds:

kind meaning
error The document is wrong, and is refused.
unavailable The document is valid; this version or this build cannot solve it.
deferred A check that needs the resolved geometry or an imported mesh file, and runs when that is built or read.
warning The document is valid; something about it is worth knowing.

This version raises 107 codes and names 3 more that a later version raises. The types, coupling terms and routes that the codes refer to are in the physics catalogue.

Boundaries and selectors (boundary)

code kind raised for
boundary.between_overlap error A between selector whose two domains share a region, where the direction of its normal is undefined.
boundary.cycle error Boundaries that name one another in a cycle (in a name, a union, a difference or an except).
boundary.empty_selection error, deferred A named boundary that selects nothing: an error of the check on the resolved boundaries, which axmp boundaries and axmp mesh run; axmp validate does not resolve the boundaries (that needs the mesher, or the info file of an imported mesh) and reports it as deferred.
boundary.imported_mesh_selector deferred A geometric boundary selector on an imported mesh, whose boundaries are the groups of its info file; resolved when the file is read.
boundary.name_collision error One name used by two of the regions, curves, domains and boundaries, which share a namespace.
boundary.partial_match warning A where filter leaves out an edge that satisfies it in part, in a boundary that selects other edges: the filter keeps an edge only when the whole edge satisfies it.
boundary.reserved_name error One of the reserved names axis, exterior and remaining used where it has no meaning.
boundary.selector_grammar error A boundary selector that is not one of the selector forms, or a filter on a form that takes none.
boundary.unknown_name error A boundary or a curve that the document does not define.

build (build)

code kind raised for
build.requires_fluids unavailable An instance mesh handed to the fluids engines (im.fluids_mesh()) in a build without the fluids module: a wheel from PyPI or the sequential source build; the MPI source build has it.
build.requires_mesher unavailable A model document with a geometry in an installation whose mesher does not run: a wheel installed without the mesh extra, or a mesher whose libraries are missing; the validation reports it, and the commands that mesh refuse the document. Design.export_gdml refuses with it a mesher that cannot be run or loaded.

Couplings (coupling)

code kind raised for
coupling.empty_overlap error A domain term whose producer and consumer share no region.
coupling.restriction_not_offered error A term restricted to part of the shared domain on a route that cannot restrict it.
coupling.selection_outside_support error The key in of a domain term names a region outside the shared domain of its two physics.
coupling.type_mismatch error A coupling term between physics types that it does not connect.
coupling.uncoupled_pair warning Two physics act on a common region with no coupling term between them.
coupling.unknown_physics error A coupling whose from or to is not a physics of the document.
coupling.unknown_term error A coupling term that is not in the catalogue.
coupling.wrong_selection_key error The key in on a boundary term, or on on a domain term.

Domains (domain)

code kind raised for
domain.unknown_name error A region or a domain that the document does not define.

Electrochemistry (electrochem)

code kind raised for
electrochem.potential_level_free error Every electrode is galvanostatic, so the potential level is free.

Expressions (expr)

code kind raised for
expr.parameter_shadows_variable error A parameter that has the name of a variable of a field expression.
expr.unknown_variable error An expression that names something that is not a variable of its context, a parameter or a constant; also the time t in a datum of an instance that a stationary step solves.
expr.vector_length error A vector datum or a point with the wrong number of components for the symmetry.

Flow (fluid)

code kind raised for
fluid.buoyancy_needs_beta error A region of a flow with the buoyancy term whose material has no fluid.beta_1_K.
fluid.condition_not_offered error A flow condition kind that the route does not offer: the engine refuses it there, or the document path does not expose it yet.
fluid.gravity_direction error A buoyancy term whose gravity is not along the vertical axis, on the Boussinesq route.
fluid.option_not_offered error A flow option value that the engine of the route refuses (the skew convective form in a transient step).
fluid.outlet_stress_form warning An outlet or open boundary with the stress viscous form: zero total traction, which a developed profile does not satisfy.
fluid.pseudo_traction_on_curved_boundary warning An outlet, traction or slip condition on a curved boundary with the Laplacian viscous form imposes a pseudo-traction.

Geometry (geometry)

code kind raised for
geometry.arc_degenerate error An arc path with a radius that is not positive, or an arc shorter than 1e-7 m (radius times angle span), which the CAD kernel cannot build.
geometry.arc_negative_r error An arc path that reaches r < 0, in any electromagnetic design but a cross-section (xsec) one (a planar design on an imported mesh included) and in an axisymmetric model document: it crosses the symmetry axis or lies beyond it.
geometry.arc_span error An arc path whose angles span more than one turn (2 pi radians), or are not finite; the angles of an arc are in radians.

Heat transfer (heat)

code kind raised for
heat.condition_not_offered error A heat condition kind that the route's engine refuses, or that the advective form excludes.
heat.data_not_regionwise error A conductivity or a heat source that differs from region to region on a route that takes one expression over the instance.
heat.option_not_offered error A heat option value that the route's engine refuses or cannot express (a P1 temperature or a conservative form on the Boussinesq route).
heat.prescribed_advection_partial error A prescribed velocity that covers part of the heat instance, or a second one.
heat.supg_needs_advection error SUPG stabilization on a heat instance that nothing advects.
heat.two_advections error A heat instance with both a prescribed velocity and an advection term.

Internal (internal)

code kind raised for
internal.mesh_export error The meshed model or an exporter of an instance mesh met what a valid document never produces (a boundary face of an instance without an atom, mesher files that disagree with the library's resolution of the boundaries, a curved mesh for a P1 chemistry field or for a route that needs straight elements): a defect of the program, not of the document.

Materials (material)

code kind raised for
material.block_incomplete error A material block without the key it needs (a thermal block without k_W_mK, a fluid block without mu_Pa_s).
material.conductivity_ambiguous error A material with sigma_S_m at the material level and in its electric block, with different values.
material.expansion_ambiguous error A material with both mechanical.alpha (the total contraction strain) and mechanical.alpha_1_K (the coefficient per kelvin).

Mesh (mesh)

code kind raised for
mesh.generation_failed error The mesher ran and failed on the geometry of a model document: the message carries the mesher's error and the hint the path of its log.
mesh.geometry_order_lowered warning The default geometry order is lowered to 1 by a P1 instance, or by an option that needs straight elements, in a model with curved boundaries.
mesh.tangled error A 2D mesh with curved (order-2) elements of which one is tangled (its Jacobian determinant changes sign, vanishes or is inverted against the other elements of its region), refused where the mesh file is read, before anything is solved; electromagnetic designs and imported mesh files raise it too.

Outputs (output)

code kind raised for
output.boundary_not_in_domain error An output of a physics on a boundary that lies outside the domain of that physics.
output.cycle error Expression outputs that read one another in a cycle.
output.force_needs_stress_form error, deferred A force or torque with the Laplacian viscous form on a Navier-Stokes route, on a boundary that is not a wall at rest; deferred to the resolution of the boundaries when the boundary is not a key of the instance's conditions.
output.force_not_offered error A force or torque of a flow on a route whose engine exposes no reaction (the one-way flow-then-heat and the Boussinesq routes); also a force or torque that belongs to no flow (it names a physics that is not a flow, or the document has none).
output.force_on_interior error A force or torque on a boundary interior to the domain of its flow, where the engine has no reaction.
output.grammar error An output whose name is not an identifier, or that lacks a key its kind needs.
output.unknown_boundary error An output on a boundary that the document does not define.
output.unknown_kind error An output kind that does not exist.
output.unknown_physics error An output that names a physics the document does not have.
output.unknown_quantity error A quantity that no physics of the document publishes in this geometry.

Patch (patch)

code kind raised for
patch.operation_failed error An operation of a patch (RFC 6902) that cannot be applied: a path that does not exist, a test that does not hold, an unknown operation or a malformed one; the document is unchanged.

Physics instances (physics)

code kind raised for
physics.boundary_double error Two conditions of a physics cover the same part of the boundary of its domain (the partition rule).
physics.boundary_interior error A condition of a physics on a boundary that is interior to its domain, also when only part of it is (the partition rule).
physics.boundary_outside_domain error A condition of a physics on a boundary that has nothing on the boundary of its domain and nothing inside it (the partition rule).
physics.boundary_uncovered error, deferred Part of the boundary of the domain of a physics has no condition: an error of the check on the resolved boundaries, which axmp boundaries and axmp mesh run (the partition rule: every part of that boundary carries exactly one condition); axmp validate reports it as deferred.
physics.domains_overlap error Two instances of one family on a shared region.
physics.invalid_id error A physics id that is not a lowercase identifier.
physics.material_block_missing error A region in a physics whose material lacks the data the route needs; also an instance that no region can take part in.
physics.property_not_uniform_over_domain error A property that the route takes as one number differs between the regions of the instance.
physics.reserved_id error A physics id that is kept for an electromagnetic section or a later physics type.
physics.source_outside_domain error The key in of a source names a region outside the domain of its physics.
physics.unknown_condition_kind error A condition kind that the physics type does not have.
physics.unknown_option error An option, or a value of an option, that the physics type does not have.
physics.unknown_source_kind error A source kind that the physics type does not have.
physics.unknown_type error A physics type that is not in the catalogue; the hint gives the name to use for another code's name, or the near matches.

Property laws (law)

code kind raised for
law.field_not_provided error A property law reads a field that no physics of the step provides on the region and that the step does not give.
law.range_missing error A property law without the validity range of a field it reads.
law.table_invalid error A table law with too few points, lists of different length, abscissae that do not increase, more than one field, or a tabulated value outside the range its property allows.
law.unknown_field error A property law of a field that no physics publishes.
law.unknown_kind error A property law that is neither an expression nor a table.
law.unknown_option error An interpolation or out_of_range value that a property law does not have.

Reactions (reaction)

code kind raised for
reaction.unknown_kind error An electrode reaction kind that does not exist.
reaction.unknown_name error An electrode condition that names a reaction the document does not declare.

Routes (route)

code kind raised for
route.domains_must_coincide error Two instances of a route that solves them on one mesh have different domains.
route.law_not_offered error A property law of a field in a property that a route of this version takes as a constant.
route.not_implemented unavailable The document is valid and this version cannot solve it: its route is not implemented yet, or no route exists for its combination of physics, coupling terms, geometry and study type; also the refusal of solving a model document, and of meshing a 3D model document, one on an imported mesh, or (in Python) one with no geometry, which this version does not do.

Study (study)

code kind raised for
study.field_not_rampable error A ramp of a field that no engine can warm-start, or of a physics that the step does not solve.
study.initial_from_unknown_step error An initial_from that does not name an earlier step.
study.ramp_end_mismatch error A ramp whose last value is not the value the document gives the field.
study.scale_not_applicable error A continuation scale with nothing to scale in its step: viscosity without a steady Navier-Stokes flow (no flow, a Stokes or Boussinesq flow, or a transient step), or buoyancy without a buoyancy term.
study.solver_value error A solver setting of a study step whose value has the wrong type: not true or false, not a whole number, or not a number.
study.strategy_not_offered error A coupling strategy that the route does not offer; also one_way written for a two-way group.
study.two_way_needs_strategy error A two-way group of physics in a step without a coupling strategy, on no route that has a default.
study.type_not_offered error A step of a study type for which the physics has no route (a stationary step over a reactor).
study.type_reserved error The study types eigen and frequency, which are kept for the electromagnetic analyses.
study.unknown_physics error A study step that names a physics the document does not have.

The document (model)

code kind raised for
model.beta_feature warning A physics type, a coupling term or a route of the document is beta.
model.element_type_not_offered deferred An imported mesh on a route whose engine takes triangles only; checked when the file is read.
model.em_only_operation error A model document given to an operation that works on electromagnetic designs only (sensitivities, optimization, the electromagnetic models, the 3D conversion).
model.em_sections_not_combinable error An electromagnetic analysis section in a document that has a physics section.
model.exterior_not_offered error The value "open" of mesh.exterior in a model document.
model.geometry_order_exceeds_field_order error, deferred A geometry order above the field order of an instance; deferred to the reading of the file for an imported mesh.
model.geometry_order_from_file error The key mesh.geometry_order beside mesh.file: the geometry order of an imported mesh is the file's.
model.geometry_order_not_offered error, deferred Geometry order 2 with an option value that needs straight elements (SUPG of a heat instance); deferred to the reading of the file for an imported mesh.
model.mesh_key_not_offered error A mesh key of an electromagnetic design that a model document does not offer (adapt).
model.mesh_order error The key mesh.order in a model document, where the field order is an option of each physics and the geometry order is mesh.geometry_order.
model.per_depth_key error An absolute input in the spelling of the other geometry: a total in a planar model, or a quantity per metre of depth in an axisymmetric or 3D one.
model.section_needs_physics error A section of a model document (domains, boundaries, reactions, couplings, study or outputs) in a document without a physics section.
model.shape_not_offered error A contour with an elliptical segment in an enabled region of a model document: the bounded meshes take lines and circular arcs.
model.symmetry_not_offered error The symmetry "xsec" in a model document.

The file (json)

code kind raised for
json.duplicate_key error A key repeated in one object of a model document's file, whose value JSON would silently replace.

Reserved

Codes that this version names, in the route table, in the details of a deferred finding or in the check on the resolved boundaries that a later version runs, and that no path of this version raises.

code kind meaning
internal.route_table_out_of_date error An engine refused what validation accepted: a defect of the route table, not of the document.
physics.option_not_offered error An option value that a route refuses, for a physics that is neither a flow nor a heat instance; no route of this version refuses one.
route.single_rank unavailable A route that runs on one MPI rank, asked to run on several.