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:

InterfaceCurrent behavior / recommended path
getEigenVectorsExported 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_fieldExported 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 tangentThe 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 --strict

The 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 namePrimary documentation
@dispReference
@showdefReference
@showfieldsReference
@showmemReference
@showmethodsReference
@showsizeReference
@showstructReference
@showtypeReference
AdvReference
AxialGradReference
BoundaryConditionReference
BoundaryConditionFieldsReference
BoundaryCondition_to_LoadConditionReference
CDMReference
CDMaccuracyAnalysisReference
CONTACT_OPENReference
CONTACT_SLIPReference
CONTACT_STICKReference
ConstitutiveMatrixReference
ContactReference
ContactGapReference
ContactSetReference
ContactStiffnessReference
CoordinateSystemReference
CurlReference
DReference
DivReference
DoFsReference
FDMReference
FieldReference
GlobalReference
GradReference
HHTReference
HHTaccuracyAnalysisReference
IIPiolaKirchhoffReference
IIPiolaKirchhoffStressReference
IdReference
LoadConditionReference
MPCReference
MaterialReference
MultiPointConstraintReference
ProblemReference
ScalarFieldReference
SurfaceDivReference
SurfaceGradReference
SurfaceSymGradReference
SymGradReference
SystemMatrixReference
SystemVectorReference
TangentialGradReference
TensorDivReference
TensorFieldReference
TransformationReference
VectorFieldReference
advectionMatrixReference
allDoFsReference
applyBoundaryConditionsReference
applyBoundaryConditions!Reference
applyElasticSupport!Reference
applyHeatConvection!Reference
beltramiMichellMatrixReference
build_csc_patternReference
collapseMPCReference
consistentToLumpedReference
constrainedDoFsReference
contactReference
curlReference
curlCurlMatrixReference
dampingMatrixReference
detReference
displacementConstraintReference
divReference
eigenValueReference
eigenVectorReference
elasticSupportReference
elasticSupportMatrixReference
elementsToElementsReference
elementsToNodesReference
energyMaterialReference
expandTo3DReference
externalTangentFollowerReference
fieldReference
fieldErrorReference
fieldsToVolumeReference
freeDoFsReference
fullReference
getEigenValuesReference
getEigenVectorsExported name; no implementation
getParameterReference
gmshBundled Gmsh API (external module)
gradReference
gradDivMatrixReference
gradMatrixReference
grad_xyReference
heatCapacityMatrixReference
heatConductionMatrixReference
heatConvectionReference
heatConvectionMatrixReference
heatConvectionVectorReference
heatFluxReference
heatFluxVectorReference
heatSourceReference
heatSourceVectorReference
initialDisplacementReference
initialDisplacement!Reference
initialStressMatrixReference
initialTemperatureReference
initialTemperature!Reference
initialVelocityReference
initialVelocity!Reference
integrateReference
internalForceVectorReference
isElementwiseReference
isNodalReference
isSavedReference
largestEigenValueReference
largestPeriodTimeReference
latentHeatMatrixReference
line_meshReference
loadReference
loadFieldReference
loadTensorReference
loadVectorReference
mapEigenValuesReference
mapScalarFieldReference
massMatrixReference
materialReference
materialTangentMatrixReference
mergeFieldsReference
navierStokesAdvectionMatrixReference
ndofsReference
nodalAcceleration!Exported name; no implementation
nodalForce!Exported name; no implementation
nodePositionVectorReference
nodesToElementsReference
nonLinearStiffnessMatrixReference
normalVectorReference
normalVectorsReference
openGeometryReference
openPostProcessorReference
openPreProcessorReference
plotOnBeamReference
plotOnPathReference
poissonMatrixReference
printElasticConstantsTableReference
probeReference
probe_fieldExported name; no implementation
projectScalarFieldReference
projectTo2DReference
reactionMatrixReference
reducedReference
reduced_bc_dataReference
reductionMatricesReference
renumberNodes!Reference
resultantReference
rigidRotationMapReference
rotReference
rotateNodesReference
rotateResultReference
saveFieldReference
scalarFieldReference
setParameterReference
setParametersReference
showBucklingResultsReference
showDeformationResultsReference
showDoFResultsReference
showEigenResultsReference
showElementResultsReference
showHeatFluxResultsReference
showModalResultsReference
showOnSurfaceReference
showStrainResultsReference
showStressResultsReference
smallestEigenValueReference
smallestPeriodTimeReference
solveAxialForceReference
solveBucklingReference
solveBucklingModesReference
solveDisplacementReference
solveEigenReference
solveEigenFieldsReference
solveEigenModesReference
solveEigenProblemReference
solveFieldReference
solveHeatFluxReference
solveModalAnalysisReference
solveStrainReference
solveStressReference
solveTemperatureReference
sourceVectorReference
spectralTransformationReference
stiffnessMatrixReference
structured_box_meshReference
structured_rect_meshReference
subSystemMatrixReference
symmetricGradientMatrixReference
tangentMatrixReference
tangentVectorReference
tangentVectorsReference
temperatureConstraintReference
tensorDivDivMatrixReference
tensorFieldReference
tensorLaplaceMatrixReference
tensorToMatrixReference
tensorToVectorReference
thermalLoadVectorReference
traceReference
traceLaplaceMatrixReference
unitTensorReference
updateContact!Reference
vectorFieldReference
εReference
∂tReference
∂xReference
∂yReference
∂zReference
∇Reference
∇_oldReference
∫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