Public API Audit
This inventory covers the loaded package exports (including aliases, types, macros and contact constants), not unused historical source files. After this documentation update, all 228 defined exported bindings have discoverable Julia documentation, including inherited alias/macro documentation. Four additional exported names have no implementation and are listed below. Docstring presence alone does not prove every behavior is correct; signatures, keyword variants, examples and component conventions were reviewed separately.
Known executable-API inconsistencies
These findings are recorded without changing executable .jl source:
| Interface | Current behavior / recommended path |
|---|---|
getEigenVectors | Exported but undefined; use eigenVector for eigenfields, or output=:raw from solveEigen. |
nodalForce!, nodalAcceleration! | Exported but undefined; no callable implementation is supplied by those names. |
probe_field | Exported but undefined; use the documented Gmsh-view probe interface where appropriate. |
Adv(P) | Calls the internal constructor without its velocity argument; use an explicit coefficient row times Grad(P) as in the advection guide. |
| Energy-based material tangent | The Tensors extension and DSL share [xx,yy,zz,xy,yz,zx]. Remove permutations from older code; see constitutive models. |
gmsh is re-exported from the bundled Gmsh API; this project does not duplicate its complete external reference. Field, MPC, ε, sourceVector and ∫N_c_dΩ are aliases; their primary documentation describes their target.
Repeatable docstring check
From the repository root, run:
python3 docs/check_api_docs.py
python3 docs/check_api_docs.py --strictThe default check fails on undocumented defined exports or newly undefined exports, and reports the four known undefined exports as warnings. --strict also fails for those known undefined names. The checker loads the actual Julia module and uses Base.Docs.hasdoc, so aliases and imported macro documentation are handled by Julia. It does not edit the project, install packages or run precompile workloads. It creates a temporary script outside the repository.
The docs/README.md file in the source tree describes an isolated local build and executable-example checks without deployment or dependency changes. Existing Julia source files are restricted to docstring changes.
Alphabetical export-to-reference map
| Public name | Primary documentation |
|---|---|
@disp | Reference |
@showdef | Reference |
@showfields | Reference |
@showmem | Reference |
@showmethods | Reference |
@showsize | Reference |
@showstruct | Reference |
@showtype | Reference |
Adv | Reference |
AxialGrad | Reference |
BoundaryCondition | Reference |
BoundaryConditionFields | Reference |
BoundaryCondition_to_LoadCondition | Reference |
CDM | Reference |
CDMaccuracyAnalysis | Reference |
CONTACT_OPEN | Reference |
CONTACT_SLIP | Reference |
CONTACT_STICK | Reference |
ConstitutiveMatrix | Reference |
Contact | Reference |
ContactGap | Reference |
ContactSet | Reference |
ContactStiffness | Reference |
CoordinateSystem | Reference |
Curl | Reference |
D | Reference |
Div | Reference |
DoFs | Reference |
FDM | Reference |
Field | Reference |
Global | Reference |
Grad | Reference |
HHT | Reference |
HHTaccuracyAnalysis | Reference |
IIPiolaKirchhoff | Reference |
IIPiolaKirchhoffStress | Reference |
Id | Reference |
LoadCondition | Reference |
MPC | Reference |
Material | Reference |
MultiPointConstraint | Reference |
Problem | Reference |
ScalarField | Reference |
SurfaceDiv | Reference |
SurfaceGrad | Reference |
SurfaceSymGrad | Reference |
SymGrad | Reference |
SystemMatrix | Reference |
SystemVector | Reference |
TangentialGrad | Reference |
TensorDiv | Reference |
TensorField | Reference |
Transformation | Reference |
VectorField | Reference |
advectionMatrix | Reference |
allDoFs | Reference |
applyBoundaryConditions | Reference |
applyBoundaryConditions! | Reference |
applyElasticSupport! | Reference |
applyHeatConvection! | Reference |
beltramiMichellMatrix | Reference |
build_csc_pattern | Reference |
collapseMPC | Reference |
consistentToLumped | Reference |
constrainedDoFs | Reference |
contact | Reference |
curl | Reference |
curlCurlMatrix | Reference |
dampingMatrix | Reference |
det | Reference |
displacementConstraint | Reference |
div | Reference |
eigenValue | Reference |
eigenVector | Reference |
elasticSupport | Reference |
elasticSupportMatrix | Reference |
elementsToElements | Reference |
elementsToNodes | Reference |
energyMaterial | Reference |
expandTo3D | Reference |
externalTangentFollower | Reference |
field | Reference |
fieldError | Reference |
fieldsToVolume | Reference |
freeDoFs | Reference |
full | Reference |
getEigenValues | Reference |
getEigenVectors | Exported name; no implementation |
getParameter | Reference |
gmsh | Bundled Gmsh API (external module) |
grad | Reference |
gradDivMatrix | Reference |
gradMatrix | Reference |
grad_xy | Reference |
heatCapacityMatrix | Reference |
heatConductionMatrix | Reference |
heatConvection | Reference |
heatConvectionMatrix | Reference |
heatConvectionVector | Reference |
heatFlux | Reference |
heatFluxVector | Reference |
heatSource | Reference |
heatSourceVector | Reference |
initialDisplacement | Reference |
initialDisplacement! | Reference |
initialStressMatrix | Reference |
initialTemperature | Reference |
initialTemperature! | Reference |
initialVelocity | Reference |
initialVelocity! | Reference |
integrate | Reference |
internalForceVector | Reference |
isElementwise | Reference |
isNodal | Reference |
isSaved | Reference |
largestEigenValue | Reference |
largestPeriodTime | Reference |
latentHeatMatrix | Reference |
line_mesh | Reference |
load | Reference |
loadField | Reference |
loadTensor | Reference |
loadVector | Reference |
mapEigenValues | Reference |
mapScalarField | Reference |
massMatrix | Reference |
material | Reference |
materialTangentMatrix | Reference |
mergeFields | Reference |
navierStokesAdvectionMatrix | Reference |
ndofs | Reference |
nodalAcceleration! | Exported name; no implementation |
nodalForce! | Exported name; no implementation |
nodePositionVector | Reference |
nodesToElements | Reference |
nonLinearStiffnessMatrix | Reference |
normalVector | Reference |
normalVectors | Reference |
openGeometry | Reference |
openPostProcessor | Reference |
openPreProcessor | Reference |
plotOnBeam | Reference |
plotOnPath | Reference |
poissonMatrix | Reference |
printElasticConstantsTable | Reference |
probe | Reference |
probe_field | Exported name; no implementation |
projectScalarField | Reference |
projectTo2D | Reference |
reactionMatrix | Reference |
reduced | Reference |
reduced_bc_data | Reference |
reductionMatrices | Reference |
renumberNodes! | Reference |
resultant | Reference |
rigidRotationMap | Reference |
rot | Reference |
rotateNodes | Reference |
rotateResult | Reference |
saveField | Reference |
scalarField | Reference |
setParameter | Reference |
setParameters | Reference |
showBucklingResults | Reference |
showDeformationResults | Reference |
showDoFResults | Reference |
showEigenResults | Reference |
showElementResults | Reference |
showHeatFluxResults | Reference |
showModalResults | Reference |
showOnSurface | Reference |
showStrainResults | Reference |
showStressResults | Reference |
smallestEigenValue | Reference |
smallestPeriodTime | Reference |
solveAxialForce | Reference |
solveBuckling | Reference |
solveBucklingModes | Reference |
solveDisplacement | Reference |
solveEigen | Reference |
solveEigenFields | Reference |
solveEigenModes | Reference |
solveEigenProblem | Reference |
solveField | Reference |
solveHeatFlux | Reference |
solveModalAnalysis | Reference |
solveStrain | Reference |
solveStress | Reference |
solveTemperature | Reference |
sourceVector | Reference |
spectralTransformation | Reference |
stiffnessMatrix | Reference |
structured_box_mesh | Reference |
structured_rect_mesh | Reference |
subSystemMatrix | Reference |
symmetricGradientMatrix | Reference |
tangentMatrix | Reference |
tangentVector | Reference |
tangentVectors | Reference |
temperatureConstraint | Reference |
tensorDivDivMatrix | Reference |
tensorField | Reference |
tensorLaplaceMatrix | Reference |
tensorToMatrix | Reference |
tensorToVector | Reference |
thermalLoadVector | Reference |
trace | Reference |
traceLaplaceMatrix | Reference |
unitTensor | Reference |
updateContact! | Reference |
vectorField | Reference |
ε | Reference |
∂t | Reference |
∂x | Reference |
∂y | Reference |
∂z | Reference |
∇ | Reference |
∇_old | Reference |
∫ | Reference |
∫N_c_N_dΩ | Reference |
∫N_c_dΩ | Reference |
∫N_c_∂N∂x_dΩ | Reference |
∫N_c_∂N∂y_dΩ | Reference |
∫N_c_∂N∂z_dΩ | Reference |
∫Γ | Reference |
∫Ω | Reference |
∫∇N_c_∇N_dΩ | Reference |
∫∇oN_c_∇oN_dΩ | Reference |
∫∇xN_c_∇xN_dΩ | Reference |
⋅ | Reference |