B Referencing Parameters
This appendix details how that model parameters can be referenced in the FEBio input files. This is used to
- write model parameters to the output file.
- reference model parameters in the parameter optimization input file.
The general format follows the following rule:
Properties and parameters are referenced by tags separated by a periods. The first tag must be the fem tag, which serves as the name of the model. (In future version this name can be user defined, but for now is fixed). Next, the name of a model property must follow. The following properties are currently defined:
- material: references a material, defined in the Material section.
- bc_fixed: references a fixed bc, defined in the Boundary section.
- bc_prescribed: references a prescribed bc, defined in the Boundary section.
- nodal_load: references a nodal load, defined in the Loads section.
- surface_load: references a surface load, defined in the Loads section.
- body_load: references a body load, define in the Loads section.
- rigid_body: references a rigid body. Rigid bodies are defined implicitly via rigid materials.
All of these properties define arrays. A specific property can be referenced via square brackets. For instance, to reference the first material in the model, do this
Alternatively, a property can also be reference by name or by ID. In either case, use round brackets. For instance, to reference by ID, do
The ID refers to the “id” attribute that can be specified for most model components. To reference by name,
Note the single quotes around the material name. The name is defined via the “name” attribute.
Note that rigid bodies can only be referenced via their material name.
Each property can have a list of parameters and sub-properties. To reference a parameter, just end the reference string with the name of the parameter. For example,
Sub properties are referenced similarly. For example, assume that the first material is a biphasic material that defines the solid property.
If the parameter itself is an array, a specific item in the array is referenced using square brackets. For example, for an EFD-neo Hookean material,
In cases where the model parameter does not define a scalar it is possible to reference the components of the parameter. For instance, for a vec3 parameter,
Nodal positions can also be referenced using the mesh property.
Element data can also be accessed.