API Reference#
fol.mesh_input_outputfol.controls- Identity control
- Dirichlet boundary control
DirichletControlDirichletControl.settingsDirichletControl.fe_meshDirichletControl.loss_functionDirichletControl.dirichlet_valuesDirichletControl.dirichlet_indicesDirichletControl.learning_dirichlet_indicesDirichletControl.learning_dirichlet_startsDirichletControl.learning_dirichlet_sizesDirichletControl.num_control_varsDirichletControl.num_controlled_varsDirichletControl.initializedDirichletControl.ComputeControlledVariables()DirichletControl.Initialize()
- Fourier-based control
FourierControlFourierControl.settingsFourierControl.fe_meshFourierControl.minFourierControl.maxFourierControl.betaFourierControl.x_freqsFourierControl.y_freqsFourierControl.z_freqsFourierControl.frquencies_vecFourierControl.num_control_varsFourierControl.num_controlled_varsFourierControl.initializedFourierControl.ComputeControlledVariables()FourierControl.Finalize()FourierControl.Initialize()
- Voronoi-based control (2D)
- Voronoi-based control (3D)
fol.loss_functions- Finite element loss base class
FiniteElementLossFiniteElementLoss.ApplyDirichletBCOnDofVector()FiniteElementLoss.ApplyDirichletBCOnElementResidualAndJacobian()FiniteElementLoss.ComputeBatchLoss()FiniteElementLoss.ComputeElement()FiniteElementLoss.ComputeElementEnergy()FiniteElementLoss.ComputeElementEnergyVmapCompatible()FiniteElementLoss.ComputeElementJacobianIndices()FiniteElementLoss.ComputeElementResidualAndJacobian()FiniteElementLoss.ComputeElementsEnergies()FiniteElementLoss.ComputeJacobianMatrixAndResidualVector()FiniteElementLoss.ComputeTotalEnergy()FiniteElementLoss.GetDOFs()FiniteElementLoss.GetFullDofVector()FiniteElementLoss.GetNumberOfUnknowns()FiniteElementLoss.GetParametersVectors()FiniteElementLoss.GetTotalNumberOfDOFs()FiniteElementLoss.Initialize()
- Linear mechanical loss functions
- Saint Venant–Kirchhoff mechanical loss functions
SaintVenantMechanicalLossSaintVenantMechanicalLoss.eSaintVenantMechanicalLoss.vSaintVenantMechanicalLoss.material_modelSaintVenantMechanicalLoss.body_forceSaintVenantMechanicalLoss.CalculateHexaGeometricStiffness3D()SaintVenantMechanicalLoss.CalculateQuadGeometricStiffness2D()SaintVenantMechanicalLoss.CalculateTetraGeometricStiffness3D()SaintVenantMechanicalLoss.CalculateTriangleGeometricStiffness2D()SaintVenantMechanicalLoss.ComputeElement()
SaintVenantMechanicalLoss2DQuadSaintVenantMechanicalLoss2DTriSaintVenantMechanicalLoss3DHexaSaintVenantMechanicalLoss3DTetra
- Neo-Hookean mechanical loss functions
- Elastoplasticity loss functions
- Kratos small-displacement mechanical loss functions
- Nonlinear thermal loss functions
- Transient thermal loss functions
TransientThermalLossTransientThermalLoss.ComputeElement()TransientThermalLoss.ComputeElementEnergy()TransientThermalLoss.ComputeElementEnergyVmapCompatible()TransientThermalLoss.ComputeElementResidualAndJacobian()TransientThermalLoss.ComputeElementResidualAndJacobianVmapCompatible()TransientThermalLoss.ComputeElementsEnergies()TransientThermalLoss.Initialize()
TransientThermalLoss2DQuadTransientThermalLoss2DTriTransientThermalLoss3DHexaTransientThermalLoss3DTetra
- Allen–Cahn phase-field loss functions
- Regression loss function
- Finite element loss base class
fol.solvers- Finite element linear solver class
FiniteElementSolverFiniteElementSolver.fe_loss_functionFiniteElementSolver.fe_solver_settingsFiniteElementSolver.linear_solver_settingsFiniteElementSolver.LinearSolveFiniteElementSolver.Initialize()FiniteElementSolver.JaxBicgstabLinearSolver()FiniteElementSolver.JaxDirectLinearSolver()FiniteElementSolver.PETScLinearSolver()
- Adjoint-based Finite Element solver
- Linear residual-based Finite Element solver
- Nonlinear finite element solver with incremental Newton–Raphson iterations and Gauss-point state variable updates
- Nonlinear finite element solver with incremental Newton–Raphson iterations
- Finite element linear solver class
fol.responses- Finite element response class
FiniteElementResponseFiniteElementResponse.response_formulaFiniteElementResponse.fe_lossFiniteElementResponse.controlFiniteElementResponse.jit_response_functionFiniteElementResponse.CalculateNMatrix()FiniteElementResponse.ComputeAdjointJacobianMatrixAndRHSVector()FiniteElementResponse.ComputeAdjointLossElementControlDerivativesVmapCompatible()FiniteElementResponse.ComputeAdjointLossElementShapeDerivativesVmapCompatible()FiniteElementResponse.ComputeAdjointNodalControlDerivatives()FiniteElementResponse.ComputeAdjointNodalShapeDerivatives()FiniteElementResponse.ComputeElementRHSVmapCompatible()FiniteElementResponse.ComputeFDNodalControlDerivatives()FiniteElementResponse.ComputeFDNodalShapeDerivatives()FiniteElementResponse.ComputeLossElementControlGrad()FiniteElementResponse.ComputeLossElementShapeGrad()FiniteElementResponse.ComputeResponseElementValue()FiniteElementResponse.ComputeResponseElementValueControlGrad()FiniteElementResponse.ComputeResponseElementValueShapeGrad()FiniteElementResponse.ComputeResponseElementValueStateGrad()FiniteElementResponse.ComputeResponseElementValueVmapCompatible()FiniteElementResponse.ComputeResponseLocalNodalControlDerivativesVmapCompatible()FiniteElementResponse.ComputeResponseLocalNodalShapeDerivativesVmapCompatible()FiniteElementResponse.ComputeValue()FiniteElementResponse.Finalize()FiniteElementResponse.Initialize()
- Notes
- Finite element response class
fol.deep_neural_networks- Deep network base class
DeepNetworkDeepNetwork.nameDeepNetwork.loss_functionDeepNetwork.flax_neural_networkDeepNetwork.optax_optimizerDeepNetwork.initializedDeepNetwork.checkpointerDeepNetwork.nnx_optimizerDeepNetwork.CheckConvergence()DeepNetwork.ComputeBatchLossValue()DeepNetwork.Finalize()DeepNetwork.GetName()DeepNetwork.GetState()DeepNetwork.Initialize()DeepNetwork.PlotHistoryDict()DeepNetwork.RestoreState()DeepNetwork.SaveCheckPoint()DeepNetwork.TestStep()DeepNetwork.Train()DeepNetwork.TrainStep()
- Explicit parametric operator learning
- Implicit parametric operator learning
ImplicitParametricOperatorLearningImplicitParametricOperatorLearning.ComputeBatchLossValue()ImplicitParametricOperatorLearning.ComputeBatchPredictions()ImplicitParametricOperatorLearning.Finalize()ImplicitParametricOperatorLearning.Initialize()ImplicitParametricOperatorLearning.Predict()ImplicitParametricOperatorLearning.PredictDynamics()
- Meta-implicit parametric operator learning
- Meta-alpha-meta implicit parametric operator learning
LatentStepModelMetaAlphaMetaImplicitParametricOperatorLearningMetaAlphaMetaImplicitParametricOperatorLearning.ComputeBatchPredictions()MetaAlphaMetaImplicitParametricOperatorLearning.GetState()MetaAlphaMetaImplicitParametricOperatorLearning.Predict()MetaAlphaMetaImplicitParametricOperatorLearning.RestoreState()MetaAlphaMetaImplicitParametricOperatorLearning.SaveCheckPoint()MetaAlphaMetaImplicitParametricOperatorLearning.TestStep()MetaAlphaMetaImplicitParametricOperatorLearning.TrainStep()
- Fourier parametric operator learning
- DeepONet parametric operator learning
- Neural fields and hypernetworks
- Deep network base class