Types
The expected type of each function argument is indicated in this reference. Here is a list of these types:
| int | integer value |
| hobj | a handle for any getfem++ object. |
| scalar | scalar value |
| string | string |
| ivec | vector of integer values |
| vec | vector |
| imat | matrix of integer values |
| mat | matrix |
| spmat | sparse matrix (both matlab native sparse matrices, and getfem sparse matrices) |
| precond | getfem preconditioner object |
| mesh | mesh object descriptor (or gfMesh object) |
| mesh_fem | mesh_fem object descriptor (or gfMeshFem object) |
| mesh_im | mesh_im object descriptor( or gfMeshIm object) |
| mesh_slice | mesh_slice object descriptor (or gfSlice object) |
| const_mesh | non-modifiable mesh object (mesh and mesh_fem can be used everywhere a const_mesh is required) |
| cvstruct | convex structure descriptor (or gfCvStruct object) |
| geotrans | geometric transformation descriptor (or gfGeoTrans object) |
| fem | fem descriptor (or gfFem object) |
| eltm | elementary matrix descriptor (or gfEltm object) |
| integ | integration method descriptor (or gfInteg object) |
Arguments listed between square brackets are optional. Lists between braces indicate that the argument must match one of the elements of the list. For example
means that the dummy function takes two or three arguments, its first being an integer value, the second a string which is either 'foo' or 'bar', and a third optional argument. It returns two values (with the usual matlab meaning, i.e. the caller can always choose to ignore them).
