Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] Partition Doxygen Docs #12836

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,43 +92,43 @@ Kratos has been used for simulation of many different problems in a wide variety
Organizations contributing to Kratos:

<img align="left" src="https://github.com/KratosMultiphysics/Documentation/raw/master/Wiki_files/Logos/CIMNE_logo.png" width="128">
</br></br><p>International Center for Numerical Methods in Engineering</p>
<br><br><p>International Center for Numerical Methods in Engineering</p>

</br></br>
<br><br>

<img align="left" src="https://github.com/KratosMultiphysics/Documentation/raw/master/Wiki_files/Logos/TUM_Logo.png" width="128">
</br><p>Chair of Structural Analysis</br>Technical University of Munich </p>
<br><p>Chair of Structural Analysis<br>Technical University of Munich </p>

</br></br>
<br><br>

<img align="left" src="https://github.com/KratosMultiphysics/Documentation/raw/master/Wiki_files/Logos/altair-sponsor-logo.png" width="128">
</br><p>Altair Engineering</p>
<br><p>Altair Engineering</p>

<img align="left" src="https://github.com/KratosMultiphysics/Documentation/raw/master/Wiki_files/Logos/Deltares_logo.png" width="128">
</br><p>Deltares</p>
<br><p>Deltares</p>

</br></br>
<br><br>

<img align="left" src="https://github.com/KratosMultiphysics/Documentation/raw/master/Wiki_files/Logos/TUBraunschweig_logo.svg" width="128">
<p>Institute of Structural Analysis</br>Technische Universität Braunschweig</p>
<p>Institute of Structural Analysis<br>Technische Universität Braunschweig</p>

</br></br>
<br><br>

<img align="left" src="https://github.com/KratosMultiphysics/Documentation/raw/master/Wiki_files/Logos/logo_UNIPD.svg" width="128">
<p> University of Padova, Italy </p>

</br></br>
<br><br>

# Our Users
Some users of the technologies developed in Kratos are:

<span>
<img align="left" src="https://github.com/KratosMultiphysics/Documentation/raw/master/Wiki_files/Logos/AIRBUS_logo.png" width="128">
<p>Airbus Defence and Space</br>Stress Methods & Optimisation Department</p>
<p>Airbus Defence and Space<br>Stress Methods & Optimisation Department</p>
</span>
<span>
<img align="left" src="https://github.com/KratosMultiphysics/Documentation/raw/master/Wiki_files/Logos/siemens_logo.png" width="128">
<p>Siemens AG</br>Corporate Technology</p>
<p>Siemens AG<br>Corporate Technology</p>
</span>
<span>
<img align="left" src="https://github.com/KratosMultiphysics/Documentation/raw/master/Wiki_files/Logos/onera_logo.png" width="128">
Expand Down
3 changes: 3 additions & 0 deletions applications/CSharpWrapperApplication/documents/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
*
!.gitignore
!doxyfile
14 changes: 14 additions & 0 deletions applications/CSharpWrapperApplication/documents/doxyfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
@INCLUDE = ../../../documents/doxyfile
PROJECT_NAME = KratosMultiphysics - C\# Wrapper
PROJECT_BRIEF =
PROJECT_LOGO = ../../../documents/kratos_small.png
LAYOUT_FILE = ../../../html_layout.xml
INPUT = .. \
../README.md
EXCLUDE_PATTERNS = */external_libraries/* \
*/custom_external_libraries/* \
*/tests/* *_test* *test_*
HTML_EXTRA_STYLESHEET = ../../../documents/doxygen-awesome.css
TAGFILES = ../../../documents/KratosCore.tag=../../../../documents/html
GENERATE_TAGFILE = CSharpWrapperApplication.tag

3 changes: 3 additions & 0 deletions applications/CableNetApplication/documents/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
*
!.gitignore
!doxyfile
15 changes: 15 additions & 0 deletions applications/CableNetApplication/documents/doxyfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
@INCLUDE = ../../../documents/doxyfile
PROJECT_NAME = KratosMultiphysics - Cable Nets
PROJECT_BRIEF =
PROJECT_LOGO = ../../../documents/kratos_small.png
LAYOUT_FILE = ../../../html_layout.xml
INPUT = .. \
../README.md
EXCLUDE_PATTERNS = */external_libraries/* \
*/custom_external_libraries/* \
*/tests/* *_test* *test_*
HTML_EXTRA_STYLESHEET = ../../../documents/doxygen-awesome.css
TAGFILES = ../../../documents/KratosCore.tag=../../../../documents/html \
../../StructuralMechanicsApplication/documents/StructuralMechanicsApplication.tag=../../../StructuralMechanicsApplication/documents/html
GENERATE_TAGFILE = CableNetApplication.tag

3 changes: 3 additions & 0 deletions applications/ChimeraApplication/documents/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
*
!.gitignore
!doxyfile
15 changes: 15 additions & 0 deletions applications/ChimeraApplication/documents/doxyfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
@INCLUDE = ../../../documents/doxyfile
PROJECT_NAME = KratosMultiphysics - Chimera
PROJECT_BRIEF =
PROJECT_LOGO = ../../../documents/kratos_small.png
LAYOUT_FILE = ../../../html_layout.xml
INPUT = .. \
../README.md
EXCLUDE_PATTERNS = */external_libraries/* \
*/custom_external_libraries/* \
*/tests/* *_test* *test_*
HTML_EXTRA_STYLESHEET = ../../../documents/doxygen-awesome.css
TAGFILES = ../../../documents/KratosCore.tag=../../../../documents/html \
../../FluidDynamicsApplication/documents/FluidDynamicsApplication.tag=../../../FluidDynamicsApplication/documents/html
GENERATE_TAGFILE = ChimeraApplication.tag

3 changes: 3 additions & 0 deletions applications/CoSimulationApplication/documents/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
*
!.gitignore
!doxyfile
14 changes: 14 additions & 0 deletions applications/CoSimulationApplication/documents/doxyfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
@INCLUDE = ../../../documents/doxyfile
PROJECT_NAME = KratosMultiphysics - CoSimulation
PROJECT_BRIEF = Core developments in coupling black-box solvers and other software-tools within KratosMultiphysics.
PROJECT_LOGO = ../../../documents/kratos_small.png
LAYOUT_FILE = ../../../html_layout.xml
INPUT = .. \
../README.md
EXCLUDE_PATTERNS = */external_libraries/* \
*/custom_external_libraries/* \
*/tests/* *_test* *test_*
HTML_EXTRA_STYLESHEET = ../../../documents/doxygen-awesome.css
TAGFILES = ../../../documents/KratosCore.tag=../../../../documents/html
GENERATE_TAGFILE = CoSimulationApplication.tag

Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
*
!.gitignore
!doxyfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
@INCLUDE = ../../../documents/doxyfile
PROJECT_NAME = KratosMultiphysics - Compressible Potential Flow
PROJECT_BRIEF =
PROJECT_LOGO = ../../../documents/kratos_small.png
LAYOUT_FILE = ../../../html_layout.xml
INPUT = .. \
../README.md
EXCLUDE_PATTERNS = */external_libraries/* \
*/custom_external_libraries/* \
*/tests/* *_test* *test_*
HTML_EXTRA_STYLESHEET = ../../../documents/doxygen-awesome.css
TAGFILES = ../../../documents/KratosCore.tag=../../../../documents/html \
../../FluidDynamicsApplication/documents/FluidDynamicsApplication.tag=../../../FluidDynamicsApplication/documents/html
GENERATE_TAGFILE = CompressiblePotentialFlowApplication.tag

Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
*
!.gitignore
!doxyfile
15 changes: 15 additions & 0 deletions applications/ConstitutiveLawsApplication/documents/doxyfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
@INCLUDE = ../../../documents/doxyfile
PROJECT_NAME = KratosMultiphysics - Constitutive Laws
PROJECT_BRIEF =
PROJECT_LOGO = ../../../documents/kratos_small.png
LAYOUT_FILE = ../../../html_layout.xml
INPUT = .. \
../README.md
EXCLUDE_PATTERNS = */external_libraries/* \
*/custom_external_libraries/* \
*/tests/* *_test* *test_*
HTML_EXTRA_STYLESHEET = ../../../documents/doxygen-awesome.css
TAGFILES = ../../../documents/KratosCore.tag=../../../../documents/html \
../../StructuralMechanicsApplication/documents/StructuralMechanicsApplication.tag=../../../StructuralMechanicsApplication/documents/html
GENERATE_TAGFILE = ConstitutiveLawsApplication.tag

9 changes: 0 additions & 9 deletions applications/ConstitutiveModelsApplication/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,3 @@
# Constitutive Models Application

This application is part of the Kratos Multiphysics Platform.
Instructions on how to update, build and run it on your local machine are available.
Please contact:

* **Josep Maria Carbonell** - *Core Development* - [[email protected]](mailto:[email protected])

## License

The Pfem application is OPEN SOURCE. The main code and program structure is available and aimed to grow with the need of any user willing to expand it. The BSD (Berkeley Software Distribution) licence allows to use and distribute the existing code without any restriction, but with the possibility to develop new parts of the code on an open or close source depending on the developers.

Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
*
!.gitignore
!doxyfile
14 changes: 14 additions & 0 deletions applications/ConstitutiveModelsApplication/documents/doxyfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
@INCLUDE = ../../../documents/doxyfile
PROJECT_NAME = KratosMultiphysics - Constitutive Models
PROJECT_BRIEF =
PROJECT_LOGO = ../../../documents/kratos_small.png
LAYOUT_FILE = ../../../html_layout.xml
INPUT = .. \
../README.md
EXCLUDE_PATTERNS = */external_libraries/* \
*/custom_external_libraries/* \
*/tests/* *_test* *test_*
HTML_EXTRA_STYLESHEET = ../../../documents/doxygen-awesome.css
TAGFILES = ../../../documents/KratosCore.tag=../../../../documents/html
GENERATE_TAGFILE = ConstitutiveModelsApplication.tag

12 changes: 0 additions & 12 deletions applications/ContactMechanicsApplication/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +0,0 @@
# Contact Mechanics Application

This application is part of the Kratos Multiphysics Platform.
Instructions on how to update, build and run it on your local machine are available.
Please contact:

* **Josep Maria Carbonell** - *Core Development* - [[email protected]](mailto:[email protected])

## License

The Pfem application is OPEN SOURCE. The main code and program structure is available and aimed to grow with the need of any user willing to expand it. The BSD (Berkeley Software Distribution) licence allows to use and distribute the existing code without any restriction, but with the possibility to develop new parts of the code on an open or close source depending on the developers.

3 changes: 3 additions & 0 deletions applications/ContactMechanicsApplication/documents/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
*
!.gitignore
!doxyfile
15 changes: 15 additions & 0 deletions applications/ContactMechanicsApplication/documents/doxyfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
@INCLUDE = ../../../documents/doxyfile
PROJECT_NAME = KratosMultiphysics - Contact Mechanics
PROJECT_BRIEF =
PROJECT_LOGO = ../../../documents/kratos_small.png
LAYOUT_FILE = ../../../html_layout.xml
INPUT = .. \
../README.md
EXCLUDE_PATTERNS = */external_libraries/* \
*/custom_external_libraries/* \
*/tests/* *_test* *test_*
HTML_EXTRA_STYLESHEET = ../../../documents/doxygen-awesome.css
TAGFILES = ../../../documents/KratosCore.tag=../../../../documents/html \
../../DelaunayMeshingApplication/documents/DelaunayMeshingApplication.tag=../../../DelaunayMeshingApplication/documents/html
GENERATE_TAGFILE = ContactMechanicsApplication.tag

Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
*
!.gitignore
!doxyfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
@INCLUDE = ../../../documents/doxyfile
PROJECT_NAME = KratosMultiphysics - Contact Mechanics
PROJECT_BRIEF =
PROJECT_LOGO = ../../../documents/kratos_small.png
LAYOUT_FILE = ../../../html_layout.xml
INPUT = .. \
../README.md
EXCLUDE_PATTERNS = */external_libraries/* \
*/custom_external_libraries/* \
*/tests/* *_test* *test_*
HTML_EXTRA_STYLESHEET = ../../../documents/doxygen-awesome.css
TAGFILES = ../../../documents/KratosCore.tag=../../../../documents/html \
../../StructuralMechanicsApplication/documents/StructuralMechanicsApplication.tag=../../../StructuralMechanicsApplication/documents/html
GENERATE_TAGFILE = ContactStructuralMechanicsApplication.tag

32 changes: 16 additions & 16 deletions applications/ConvectionDiffusionApplication/README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,32 @@
## Convection Diffusion Application
The Convection DIffusion Application contains a series of elements and conditions and the corresponding strategies and solvers within Kratos Multiphysics necesaries in order to simulate a convection-diffusion problem.
<p align="center">
<img src="https://raw.githubusercontent.com/KratosMultiphysics/Documentation/master/Readme_files/ConvectionDiffusionApplication.png" alt="Solution" style="width: 600px;"/>
</p>
The application includes tests to check the proper functioning of the application
### Features:

## Convection Diffusion Application

A set of elements, conditions, strategies and solvers necessary for the solution of convection-diffusion problems.

<p align="center">
<img src="https://raw.githubusercontent.com/KratosMultiphysics/Documentation/master/Readme_files/ConvectionDiffusionApplication.png" alt="Solution" style="width: 600px;"/>
</p>

The application includes tests to check the proper functioning of the application

### Features:

- A set of *Neumann* conditions:
* Flux conditions
* Thermal conditions

- Elements:
* Laplacian element (both 2D/3D)
* Eulerian convection-diffusion (both 2D/3D)
* Convection-diffusion (both 2D/3D)
* Convection-diffusion with change of phase (2D)
* Explicit eulerian convection-diffusion (both 2D/3D)

- Strategies:
* Non-linear/linear convection-diffusion strategy
* Eulerian convection-diffusion strategy
* Semi-Eulerian convection-diffusion strategy

- Utilities and others:
* BFECC convection utility
* BFECC elemental limiter convection utility
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
*
!.gitignore
!doxyfile
14 changes: 14 additions & 0 deletions applications/ConvectionDiffusionApplication/documents/doxyfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
@INCLUDE = ../../../documents/doxyfile
PROJECT_NAME = KratosMultiphysics - Convection-Diffusion
PROJECT_BRIEF = A set of elements, conditions, strategies and solvers necessary for the solution of convection-diffusion problems.
PROJECT_LOGO = ../../../documents/kratos_small.png
LAYOUT_FILE = ../../../html_layout.xml
INPUT = .. \
../README.md
EXCLUDE_PATTERNS = */external_libraries/* \
*/custom_external_libraries/* \
*/tests/* *_test* *test_*
HTML_EXTRA_STYLESHEET = ../../../documents/doxygen-awesome.css
TAGFILES = ../../../documents/KratosCore.tag=../../../../documents/html
GENERATE_TAGFILE = ConvectionDiffusionApplication.tag

3 changes: 3 additions & 0 deletions applications/DEMApplication/documents/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
*
!.gitignore
!doxyfile
14 changes: 14 additions & 0 deletions applications/DEMApplication/documents/doxyfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
@INCLUDE = ../../../documents/doxyfile
PROJECT_NAME = KratosMultiphysics - Discrete Elements
PROJECT_BRIEF = A particles method for modeling the bulk behavior of granular materials and many geomaterials such as coal, ores, soil, rocks, aggregates, pellets, tablets and powders.
PROJECT_LOGO = ../../../documents/kratos_small.png
LAYOUT_FILE = ../../../html_layout.xml
INPUT = .. \
../README.md
EXCLUDE_PATTERNS = */external_libraries/* \
*/custom_external_libraries/* \
*/tests/* *_test* *test_*
HTML_EXTRA_STYLESHEET = ../../../documents/doxygen-awesome.css
TAGFILES = ../../../documents/KratosCore.tag=../../../../documents/html
GENERATE_TAGFILE = DEMApplication.tag

3 changes: 3 additions & 0 deletions applications/DamApplication/documents/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
*
!.gitignore
!doxyfile
17 changes: 17 additions & 0 deletions applications/DamApplication/documents/doxyfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
@INCLUDE = ../../../documents/doxyfile
PROJECT_NAME = KratosMultiphysics - DAM
PROJECT_BRIEF =
PROJECT_LOGO = ../../../documents/kratos_small.png
LAYOUT_FILE = ../../../html_layout.xml
INPUT = .. \
../README.md
EXCLUDE_PATTERNS = */external_libraries/* \
*/custom_external_libraries/* \
*/tests/* *_test* *test_*
HTML_EXTRA_STYLESHEET = ../../../documents/doxygen-awesome.css
TAGFILES = ../../../documents/KratosCore.tag=../../../../documents/html \
../../ConvectionDiffusionApplication/documents/ConvectionDiffusionApplication.tag=../../../ConvectionDiffusionApplication/documents/html \
../../PoromechanicsApplication/documents/PoromechanicsApplication.tag=../../../PoromechanicsApplication/documents/html \
../../StructuralMechanicsApplication/documents/StructuralMechanicsApplication.tag=../../../StructuralMechanicsApplication/documents/html
GENERATE_TAGFILE = DamApplication.tag

3 changes: 3 additions & 0 deletions applications/DelaunayMeshingApplication/documents/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
*
!.gitignore
!doxyfile
14 changes: 14 additions & 0 deletions applications/DelaunayMeshingApplication/documents/doxyfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
@INCLUDE = ../../../documents/doxyfile
PROJECT_NAME = KratosMultiphysics - Delaunay Meshing
PROJECT_BRIEF =
PROJECT_LOGO = ../../../documents/kratos_small.png
LAYOUT_FILE = ../../../html_layout.xml
INPUT = .. \
../README.md
EXCLUDE_PATTERNS = */external_libraries/* \
*/custom_external_libraries/* \
*/tests/* *_test* *test_*
HTML_EXTRA_STYLESHEET = ../../../documents/doxygen-awesome.css
TAGFILES = ../../../documents/KratosCore.tag=../../../../documents/html
GENERATE_TAGFILE = DelaunayMeshingApplication.tag

Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
*
!.gitignore
!doxyfile
Loading
Loading