diff --git a/doc/dev-doc/index.rst b/doc/dev-doc/index.rst index c7116d93f..34de864af 100644 --- a/doc/dev-doc/index.rst +++ b/doc/dev-doc/index.rst @@ -1,49 +1,50 @@ .. Akantu documentation master file, created by sphinx-quickstart on Fri Apr 17 16:35:46 2020. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. Akantu: a FEM library ===================== .. toctree:: :maxdepth: 2 :caption: User Manual ./manual/getting_started.rst ./manual/fe_engine.rst ./manual/solidmechanicsmodel.rst ./manual/heattransfermodel.rst + ./manual/phasefieldmodel.rst ./manual/structuralmechanicsmodel.rst ./manual/io.rst .. toctree:: :maxdepth: 2 :caption: Changelog ./changelog.rst .. toctree:: :maxdepth: 2 :caption: API Reference ./reference.rst .. toctree:: :maxdepth: 2 :caption: Appendix ./manual/appendix.rst .. toctree:: :maxdepth: 2 :caption: Bibliography ./manual/bibliography.rst Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search` diff --git a/doc/dev-doc/reference.rst b/doc/dev-doc/reference.rst index 0550062f5..20f199e39 100644 --- a/doc/dev-doc/reference.rst +++ b/doc/dev-doc/reference.rst @@ -1,101 +1,114 @@ .. _reference: Reference --------- Common `````` .. doxygenfunction:: akantu::initialize(const std::string &input_file, int &argc, char **&argv) .. doxygenfunction:: akantu::initialize(int &argc, char **&argv) .. doxygentypedef:: akantu::UInt .. doxygentypedef:: akantu::Int .. doxygentypedef:: akantu::Real .. doxygenenum:: akantu::ElementType .. doxygenenum:: akantu::ModelType .. doxygenenum:: akantu::AnalysisMethod .. doxygenenum:: akantu::SolveConvergenceCriteria .. doxygenclass:: akantu::ArrayBase .. doxygenclass:: akantu::ArrayDataLayer .. doxygenclass:: akantu::Array .. doxygenclass:: akantu::ElementTypeMapArray .. doxygenclass:: akantu::Vector .. doxygenclass:: akantu::Matrix Mesh ```` .. doxygenclass:: akantu::Mesh .. doxygenclass:: akantu::FEEngine Models `````` Common ...... .. doxygenclass:: akantu::BC::Dirichlet::FixedValue .. doxygenclass:: akantu::BC::Dirichlet::FlagOnly .. doxygenclass:: akantu::BC::Dirichlet::IncrementValue .. doxygenclass:: akantu::BC::Neumann::FromStress .. doxygenclass:: akantu::BC::Neumann::FromTraction .. doxygenclass:: akantu::BoundaryCondition .. doxygenclass:: akantu::BoundaryConditionFunctor .. doxygenclass:: akantu::EventHandlerManager .. doxygenclass:: akantu::Model .. doxygenclass:: akantu::NonLocalManagerCallback Solvers ....... .. doxygenclass:: akantu::ModelSolver .. doxygenclass:: akantu::DOFManager .. doxygenclass:: akantu::NonLinearSolver .. doxygenclass:: akantu::NonLinearSolverNewtonRaphson Solid Mechanics Model ..................... .. doxygenclass:: akantu::SolidMechanicsModel .. doxygenclass:: akantu::SolidMechanicsModelOptions .. doxygenclass:: akantu::MaterialSelector .. doxygenclass:: akantu::MeshDataMaterialSelector .. doxygenclass:: akantu::Material .. doxygenclass:: akantu::InternalField Solid Mechanics Model Cohesive .............................. .. doxygenclass:: akantu::SolidMechanicsModelCohesive .. doxygenclass:: akantu::FragmentManager Heat Transfer Model ................... .. doxygenclass:: akantu::HeatTransferModel +Phase Field Model +................... + +.. doxygenclass:: akantu::PhaseFieldModel +.. doxygenclass:: akantu::PhaseField + Structural Mechanics Model .......................... .. doxygenclass:: akantu::StructuralMaterial .. doxygenclass:: akantu::StructuralMechanicsModel + +Coupler Solid PhaseField +................... + +.. doxygenclass:: akantu::CouplerSolidPhaseField + + Synchronizers ````````````` .. doxygenclass:: akantu::DataAccessor Input/Output ```````````` .. doxygenclass:: akantu::Dumpable .. doxygenclass:: akantu::DumperIOHelper .. doxygenclass:: akantu::DumperParaview .. doxygenclass:: akantu::DumperText .. doxygenclass:: akantu::Field .. doxygenclass:: akantu::Parser .. doxygenclass:: akantu::ParserParameter .. doxygenclass:: akantu::ParserSection .. doxygenenum:: akantu::SectionType