Documentation
If GIBBON is installed properly the documentation is also available (and fully searchable) from within MATLAB (see installation instructions).
The documentation is a work in progress. Not all functions have associated help files and not all functionality is covered by the demos. The help files currently cover about 50% of the functions and the demos mainly cover the use of FEBio.
HELP and DEMO files
The name for all function help files starts with HELP_
, and all demo files start with DEMO_
. This way users may explore/open/edit these files by typing open HELP_functionName
or open DEMO_demoName
in the MATLAB command window.
- abaqusStruct2inp
- addAttributeSetXML
- addAttributeXML
- addElementSetXML
- addElementValueXML
- addElementXML
- addHelpSearch
- adjacentdircount
- affineTransformationMatrixDirect
- agd
- amfStruct2xml
- anim8
- axis_inc
- axisGeom
- axisLim
- batman
- bezierCurve
- bias_nodes1d
- biharmonicSplineInterpolation
- blood
- bloodbone
- box_indices
- boxconstrain
- cap_patchcylinder
- cart2im
- cell2txtfile
- cellEig
- cellPair2struct
- cellTrace
- cFigure
- changeFileExtensions
- che
- circlefit
- cividis
- ckmkdir
- cleanDir
- cleanUpTetGen
- cmaperise
- coarsepatch
- coneTriMesh
- constrainedDelaunayTetGen
- contour2levelset
- contour2logic
- contourRegularise
- cow
- createHelpDemoDocumentation
- crossProdMat
- cs3dPath
- csapsPar
- cunique
- curvePathOrderFix
- curveToEdgeList
- DCM2euler
- dcmFolder2MATobject
- dcmFolderAnon
- defMetrics
- delaunayZip
- dev
- diamondLattice
- dicom3Dpar
- dihedralAngles
- discQuadMesh
- disp2strain
- dispDoneGibbonCode
- dispStartTitleGibbonCode
- distND
- doubleContraction
- dualClad
- dualLattice
- dyadicProduct
- edgeLengths
- edgeListToCurve
- edgeNormal
- edgeVec
- efw
- element2faces
- element2HexLattice
- element2lattice
- element2patch
- elephant
- ellipseCoord
- ellipseCoord3
- ellipseFit
- ellipseFit3
- ellipsoidFit_centered
- errorbarC_XY
- euler2DCM
- eulerChar
- evenlySampleCurve
- evenlySpaceCurve
- export_INP
- export_mesh
- export_off
- export_STL_txt
- exportGif
- exportGifAnim8
- faceToVertexMeasure
- febio
- febioDoc
- febioStruct2xml
- febioStructTemplate
- febView
- femur
- FFT_derivative
- fftnconv
- filletCurve
- fire
- fireice
- fixNormalsOutward
- flare
- fmin_fvalfind_ppform
- fmin_symbolic_form
- foamWrap
- fourthOrderCell
- fourthOrderMat
- freeBoundaryPatch
- freeMemory
- gabor_kernel
- gaborCoil
- gaborFilter
- gauss_kernel
- gaussianpdf
- gcombvec
- gcontains
- gcontour
- gd
- gdoc
- gdrawnow
- gedge
- geoSphere
- getColumns
- getFEBioPath
- getFebioSpecVersion
- getimdat
- getInnerPoint
- getInnerVoxel
- getSubPaths
- getTestFiles
- getViewProfile
- getVoronoiStats
- ggremesh
- gjet
- gpatch
- gpublish
- gramSchmidtOrtho
- graphicsModels
- gray2RGBColorMap
- grayColor
- graygjet
- grayjet
- grayJetc
- grid2patch
- griddata_delaunay
- groupVertices
- gtitle
- gviridis
- gxmlwrite
- hemiSphereCylMesh
- hemiSphereMesh
- hemiSphereRegionMesh
- hessianScalar
- hex2patch
- hex2rdl
- hex2tet
- hex8_hex20
- hexahedral_hexagon_beam
- hexMeshBox
- hexMeshCubeSphere
- hexMeshCylinder
- hexMeshHemiSphere
- hexMeshSphere
- hexVol
- hip_implant
- honeyCombMesh
- ice
- icolorbar
- igviridis
- im2cart
- im2MRcart
- im2MRcartNeg
- im2patch
- image_numeric
- imageResample
- imlabelMean
- immesh
- import_FEB
- import_INP
- import_obj
- import_off
- import_STL
- import_STL_bin
- import_STL_txt
- importAbaqusDat
- importAnyBodyOutput
- importEleFile_tetGen
- importFaceFile_tetGen
- importFEBio_logfile
- importNodeFile_tetGen
- importTETGEN
- imrician
- imsphere_IND_INT
- imx
- inc2cumDisp
- ind2logic
- ind2patch
- ind2subn
- inddiag
- inddisp2cumdisp
- inferno
- inputdlgStruct
- insphere
- interp1_ND
- interp_polar
- interp_spherical
- interpDirVec
- intesselation
- intriangle
- inv_parbound
- isapprox
- isclose
- isConvexPolyhedron
- iseven
- isGlobalSurfDirOutward
- ishappy
- isInsideTR
- isPolyClockwise
- isrounded
- isrowmember
- ivoigtMap
- iwarmcold
- joinElementSets
- kabschRotationMatrix
- kelvinMap
- kelvinUnMap
- kronDelta
- kvw
- kwJet
- lameInvertHookeOrthotropic
- laplacian_smoothing
- levelset2isosurface
- lineVec
- linspacen
- loftLinQuad2hex
- logic2isosurface
- logic2levelset
- logic2subind
- logicErodeDilate
- logicRemoveInterior
- logit
- loremIpsum
- magma
- makeSymbolicStiffnessTensor
- mask_design
- maskfind
- maskimage
- mat2strIntDouble
- matplotlibColormap
- maxDist
- maxFig
- maxnumel
- mcol
- meanfilt3
- meanValueCoordinates
- mergeImageData
- mergeImageSet
- mergeVertices
- mesh2tri
- meshBoundary
- meshCleave
- meshDistMarch
- meshView
- mfv
- minDist
- minFig
- minPolyTwist
- mJet
- MRcart2im
- MRcart2imNeg
- MRimageUnitScale
- mrow
- multiRegionTriMesh2D
- multiRegionTriMeshUneven2D
- ndet
- nonlinspace
- nowStr
- numConnect
- numOrder
- numReplace
- oblique_mask
- ongrid
- orange
- overobj2
- padeven
- padLinDim
- padrep
- parasaurolophus
- parbound
- parHipImplant
- parLimNat
- patch2EdgeIm
- patch2edgeIND
- patch2Im
- patch2obj
- patch2STL
- patch2tri
- patch_dual
- patchArea
- patchBoundary
- patchCentre
- patchCleanUnused
- patchClosedCylinder
- patchConnectivity
- patchCount
- patchCurvature
- patchCurvaturePolynomial
- patchcylinder
- patchCylSurfClose
- patchDetach
- patchEdge2Im
- patchEdgeAngles
- patchEdgeCollapse
- patchEdgeLengths
- patchEdges
- patchExtend
- patchExtrude
- patchFaceAngles
- patchFeatureDetect
- patchIND
- patchMarchDistMapIterative
- patchNanFix
- patchNormal
- patchNormalFix
- patchNormPlot
- patchPathAngles
- patchPointDist
- patchRemoveCollapsed
- patchSmooth
- patchThick
- patchTorus
- patchVectorTangent
- patchVolume
- pathLength
- pathSepFix
- pdfView
- pentaVol
- pillowHex
- plane_fit
- plane_intersect
- plasma
- platonic_solid
- plotContours
- plotV
- point2TriSurfDist
- pointAnnotate
- pointCloudPrinDir
- pointLocationTR
- pointLocationTR_parfor
- pointSetDistMap
- pointSetPrincipalDir
- polar_loop_space
- polyarea_signed
- polycentroid
- polyCircularity
- polyContourThick
- polyCurveLength
- polyExtrude
- polyLineIntersect
- polyLoftLinear
- polyNormal
- polyOrderDelaunay
- polyResample
- polyRevolve
- polySet2Im
- polythick
- polyTube
- pp_x_at_y
- ppInv
- ppval_extrapVal
- prin2effective
- pround
- publishHelpDocAll
- qginput
- quad2tri
- quad4_quad8
- quad_smooth
- quadBox
- quadPlate
- quadrep
- quadSphere
- quadSurfRemoveTwoConnect
- quadThick
- quiver3Dpatch
- quiverCurve
- quiverLine
- quiverTriad
- quiverVec
- R_squared
- rand_angle
- randInCircle
- rayleighpdf
- reactionDiffusionMesh
- regionTriMesh2D
- regionTriMesh3D
- regionTriMeshRand2D
- remeshTriSurfDistMap
- removeNotIndexed
- resampleColormap
- rgbImage2ColorMap
- rhombicDodecahedron
- rhombicDodecahedronHex
- rhombicDodecahedronMesh
- rician_LMMSE_filter
- ricianpdf
- rigidbody_transform
- rigidTransformationMatrixDirect
- rigidTransformVertices
- rms
- rot2VecAngle
- rotate_vertices
- rozenbrock
- runMonitorFEBio
- runTetGen
- sampleCurveEvenly
- sawtoothWave
- scalePatch
- scancell
- scatter_stats
- scatterV
- scf
- scramble
- seedIndex2triangulation
- selectBox
- set_output_request_FEBIO
- setFEBioPath
- setViewProfile
- shear_bulk2poisson
- shear_poisson2bulk
- shiftV
- sigmoid_pchip
- simplexImIntersect
- sliceIntersectPatch
- smoothHeaviside
- smoothSquareWave
- smoothTaubin
- snap2grid
- snapSubInd
- sparseMin
- sparseSphericalMask
- specialPointerShape
- sph
- sphereOctant
- spinodoid
- splitCurveSetMesh
- splitVertices
- spmax
- spmin
- squircle
- sround
- stanford_bunny
- stochasticMicrostructure
- struct2txt
- structComplete
- strwrap
- sub2indn
- subCurve
- subEdge
- subHex
- subImage
- subQuad
- subQuadCatmullClark
- subTet
- subtri
- subTriCentre
- subTriDual
- subTriLocal
- subTriLoop
- subTriSplit
- surf_slice
- surface_intersect
- surfacePairIntersect
- sv2
- sv3
- SVD_filter
- sweepCurveBezier
- sweepCurveSmooth
- sweepLoft
- tensor2voigtMap
- tensorArray2tensorCell
- tesBoundary
- tesgrid
- tesgroup
- tesIND
- tesSmooth
- tesSmooth_HC
- tesSmooth_LAP
- tesSmoothPosNeg
- testGibbon
- tet2hex
- tet4_tet10
- tetMeshBox
- tetVol
- textImage
- textView
- tform
- thetaphi2DCM
- thetaphi2vec
- tri2quad
- tri2quadGroupSplit
- tri2rhombi
- tri3_tri6
- tri6_subtri3
- tri_area
- triangle_wave
- triangleRayIntersection
- triangleWave
- triBox
- triEdgeSplit
- trigradient
- triIncenter
- triLinearTet_F
- triLinearTri_F
- triLinearTri_F2D
- triMeshEquilateral
- trinorm
- triplet_find
- triplyPeriodicMinimal
- triplyPeriodicMinimalSurface
- triPolyDualRefine
- triRemeshLabel
- TriScatteredInterp_nat_near
- TriScatteredInterp_ND
- triSurf2Im
- triSurf2ImSpec
- trisurf_intersect
- triSurfCentroid
- triSurfCloseHoles
- triSurfLogicSharpFix
- triSurfPermuteColor
- triSurfRayTrace
- triSurfRemoveThreeConnect
- triSurfSelfTriangulateBoundary
- triSurfSetDist
- triSurfSlice
- trisurfsmooth
- triSurfSmoothFourier
- trisurfsmoothHC
- triSurfVolume
- triThick
- truncatedOctahedron
- truncatedOctahedronMesh
- truncatePolyhedra
- txt2struct
- txtfile2cell
- uiThreshErode
- ukr
- unique_map
- unique_patch
- uniqueIntegerRow
- unpadeven
- unsharp
- unzipAll
- utah_teapot
- var2cellstr
- vcw
- vec2strIntDouble
- vec_normalize
- vecAngle2Rot
- vecnormalize
- vecPairClosestPoint
- vectorOrthogonalPair
- vectorTensorProductArray
- vertexToFaceMeasure
- viewFourthOrderTensor
- viridis
- voigtMap
- voigtUnMap
- vonMisesStat
- vorMap2triSurf
- voxelate
- waitForValidButtonPress
- warmcold
- wcbp
- wjet
- wmean
- write_FEB_input
- write_XML_no_extra_lines
- writeBasicSmesh
- writeMtrFile_tetGen
- writeNodeFile_tetGen
- xmlView
- DEMO_abaqus_0001_cube_uniaxial
- DEMO_abaqus_0002_blob_shear_contact
- DEMO_abaqus_0003_cylinder_inflate
- DEMO_additional_colormaps
- DEMO_aorta_build_passive_01
- DEMO_febio_0001_cube_uniaxial
- DEMO_febio_0002_beam_force
- DEMO_febio_0003_beam_bending
- DEMO_febio_0004_beam_twist
- DEMO_febio_0005_cube_tension_compression_shear
- DEMO_febio_0006_sphere_indentation
- DEMO_febio_0007_sphere_sliding
- DEMO_febio_0008_cube_body_load
- DEMO_febio_0009_cube_discrete_springs
- DEMO_febio_0010_trabeculae_compression
- DEMO_febio_0011_cube_multi_generation
- DEMO_febio_0012_disc_pressure
- DEMO_febio_0013_disc_pressure_varying
- DEMO_febio_0014_cube_varying_material
- DEMO_febio_0015_cube_fibers_transiso
- DEMO_febio_0016_cube_viscoelastic_ramp_hold
- DEMO_febio_0017_cube_viscoelastic_load_unload
- DEMO_febio_0018_cube_poroelastic_ramp_hold
- DEMO_febio_0019_vessel_pressure_inflate
- DEMO_febio_0020_vessel_balloon_inflate
- DEMO_febio_0021_bone_three_point_bending
- DEMO_febio_0022_multigen_interface_band
- DEMO_febio_0023_beam_gravity_body_load
- DEMO_febio_0024_active_contraction_tongue
- DEMO_febio_0025_cube_uniaxial_stiffness_analysis
- DEMO_febio_0026_hexlattice_compression
- DEMO_febio_0027_layer_spatially_varying_material
- DEMO_febio_0028_sphere_indentation_friction_twist
- DEMO_febio_0029_contact_friction_benchmark_boxes
- DEMO_febio_0030_block_varying_nodal_forces
- DEMO_febio_0031_blob_shear_contact
- DEMO_febio_0032_sphere_tube_slide
- DEMO_febio_0033_sphere_tube_slide_body_force
- DEMO_febio_0034_sphere_cone_slide_body_force
- DEMO_febio_0035_blob_shear_contact_hex8
- DEMO_febio_0036_sphere_branches_slide_body_force
- DEMO_febio_0037_lattice_test_octet_truss_01
- DEMO_febio_0038_cube_uniaxial_HGO
- DEMO_febio_0039_nut_bolt_ring
- DEMO_febio_0040_propeller_contact
- DEMO_febio_0041_beam_L_force
- DEMO_febio_0042_inverse_FEA_cube_uniaxial
- DEMO_febio_0043_pyra5_element
- DEMO_febio_0044_mammography_01
- DEMO_febio_0045_tentacle_active_contraction_01
- DEMO_febio_0047_cylinder_embedded_probe_01
- DEMO_febio_0049_gap_close_01
- DEMO_febio_0050_foot_insole_01
- DEMO_febio_0051_hip_implant_01
- DEMO_febio_0052_breast_gap_close_01
- DEMO_febio_0054_lattice_hydrostatic_01
- DEMO_febio_0056_cylinder_embedded_probe_02
- DEMO_febio_0057_diamond_lattice_compression_01
- DEMO_febio_0059_face_mask_loading
- DEMO_febio_0060_vertebrae_disc_01
- DEMO_febio_0061_breast_gravity_01
- DEMO_febio_0062_femur_load_01
- DEMO_febio_0063_custom_hip_implant_01
- DEMO_febio_0065_clamp_tension_test
- DEMO_febio_0066_clamp_tension_test_friction
- DEMO_febio_0067_hip_implant_regional_stiffness_optimize_01
- DEMO_febio_0068_roll_self_contact_01
- DEMO_febio_0069_must_points_export
- DEMO_febio_0070_pneunet_actuator_simple_01
- DEMO_febio_0071_pneunet_actuator_set_01
- DEMO_febio_0072_pneunet_actuator_set_disp_01
- DEMO_febio_0073_deformable_cylinders_contact_01
- DEMO_febio_0074_vertebrae_compression_01
- DEMO_febio_0075_cube_donnan_equilibrium_swelling_01
- DEMO_febio_0076_actuator_donnan_equilibrium_swelling_01
- DEMO_febio_0077_cube_perfect_osmometer_01
- DEMO_febio_0078_actuator_perfect_osmometer_01
- DEMO_febio_0079_tire_load_01
- DEMO_febio_0080_kirigami_gripper_01
- DEMO_febio_0081_interface_tear_sticky_01
- DEMO_febio_0081_kresling_unit_01
- DEMO_febio_0082_kresling_unit_subtri_01
- DEMO_febio_0083_kresling_unit_regiontrimesh_02
- DEMO_febio_0084_kresling_unit_shell_03
- DEMO_febio_0085_soft_robotic_star_01
- DEMO_febio_0086_earbud_insert_01
- DEMO_febio_0087_inverse_FEA_cube_uniaxial_viscoelastic
- DEMO_febio_0090_expanding_lattice_01
- DEMO_geodesic_remeshing
- DEMO_heart_contours_hex_mesh_warping_01
- DEMO_imx_levelset_surface_compare
- DEMO_Jansen_linkage_animation_01
- DEMO_JOSS_logo
- DEMO_mesh_bifurcation_angle_control
- DEMO_mesh_bifurcation_cut_loft_branch
- DEMO_MixedTetHexMeshing
- DEMO_MixedTetHexMeshing_torus
- DEMO_obj_resample_texture
- DEMO_stent_design_sigmoid_01
- DEMO_stent_hexahedral_sweeping
- DEMO_stent_hexahedral_sweeping_02
- DEMO_surface_smooth_methods
- DEMO_visualization_von_mises_plasticity_01
- DEMO_volumetric_SED_eval