Skip to content

Commit

Permalink
Merge pull request #11 from fabricix/manual
Browse files Browse the repository at this point in the history
Manual Part 1. 
The detailed description of the update stress algorithm must be added in other contribution.
  • Loading branch information
fabricix authored Dec 4, 2024
2 parents f580bdb + f3ce57f commit b9d4472
Show file tree
Hide file tree
Showing 62 changed files with 2,671 additions and 543 deletions.
5 changes: 3 additions & 2 deletions Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -971,7 +971,8 @@ INPUT = ./inc/ \
./inc/Particle/ \
./inc/Mesh/ \
./inc/Shape/ \
./inc/Solver/
./inc/Solver/ \
./manual

# This tag can be used to specify the character encoding of the source files
# that Doxygen parses. Internally Doxygen uses the UTF-8 encoding. Doxygen uses
Expand Down Expand Up @@ -1122,7 +1123,7 @@ EXAMPLE_RECURSIVE = NO
# that contain images that are to be included in the documentation (see the
# \image command).

IMAGE_PATH =
IMAGE_PATH = manual\images

# The INPUT_FILTER tag can be used to specify a program that Doxygen should
# invoke to filter for each input file. Doxygen will invoke the filter program
Expand Down
162 changes: 81 additions & 81 deletions docs/MPM_8h_source.html

Large diffs are not rendered by default.

66 changes: 33 additions & 33 deletions docs/Output_8h_source.html

Large diffs are not rendered by default.

118 changes: 118 additions & 0 deletions docs/dir_000000_000003.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MPM-Geomechanics: Body -&gt; Materials Relation</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="custom-html-style.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">MPM-Geomechanics
</div>
<div id="projectbrief">Material Point Method for simulating geo-materials under large deformation conditions</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('dir_f1270302287848fabb3590603b4a7bf4.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div class="contents">
<h3>Body &rarr; Materials Relation</h3><table class="dirtab"><tr class="dirtab"><th class="dirtab">File in inc/Body</th><th class="dirtab">Includes file in inc/Materials</th></tr><tr class="dirtab"><td class="dirtab"><a class="el" href="Body_8h.html">Body.h</a></td><td class="dirtab"><a class="el" href="Material_8h.html">Material.h</a></td></tr></table></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_bfccd401955b95cf8c75461437045ac0.html">inc</a></li><li class="navelem"><a class="el" href="dir_f1270302287848fabb3590603b4a7bf4.html">Body</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0 </li>
</ul>
</div>
</body>
</html>
118 changes: 118 additions & 0 deletions docs/dir_000000_000005.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MPM-Geomechanics: Body -&gt; Particle Relation</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="custom-html-style.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">MPM-Geomechanics
</div>
<div id="projectbrief">Material Point Method for simulating geo-materials under large deformation conditions</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('dir_f1270302287848fabb3590603b4a7bf4.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div class="contents">
<h3>Body &rarr; Particle Relation</h3><table class="dirtab"><tr class="dirtab"><th class="dirtab">File in inc/Body</th><th class="dirtab">Includes file in inc/Particle</th></tr><tr class="dirtab"><td class="dirtab"><a class="el" href="Body_8h.html">Body.h</a></td><td class="dirtab"><a class="el" href="Particle_8h.html">Particle.h</a></td></tr></table></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_bfccd401955b95cf8c75461437045ac0.html">inc</a></li><li class="navelem"><a class="el" href="dir_f1270302287848fabb3590603b4a7bf4.html">Body</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0 </li>
</ul>
</div>
</body>
</html>
4 changes: 2 additions & 2 deletions docs/dir_000001_000003.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MPM-Geomechanics: inc -&gt; Mesh Relation</title>
<title>MPM-Geomechanics: inc -&gt; Materials Relation</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
Expand Down Expand Up @@ -105,7 +105,7 @@
</div>

<div class="contents">
<h3>inc &rarr; Mesh Relation</h3><table class="dirtab"><tr class="dirtab"><th class="dirtab">File in inc</th><th class="dirtab">Includes file in inc/Mesh</th></tr><tr class="dirtab"><td class="dirtab"><a class="el" href="Integration_8h.html">Integration.h</a></td><td class="dirtab"><a class="el" href="Mesh_8h.html">Mesh.h</a></td></tr><tr class="dirtab"><td class="dirtab"><a class="el" href="MPM_8h.html">MPM.h</a></td><td class="dirtab"><a class="el" href="Mesh_8h.html">Mesh.h</a></td></tr><tr class="dirtab"><td class="dirtab"><a class="el" href="Output_8h.html">Output.h</a></td><td class="dirtab"><a class="el" href="Mesh_8h.html">Mesh.h</a></td></tr><tr class="dirtab"><td class="dirtab"><a class="el" href="Update_8h.html">Update.h</a></td><td class="dirtab"><a class="el" href="Mesh_8h.html">Mesh.h</a></td></tr><tr class="dirtab"><td class="dirtab"><a class="el" href="dir_94768b30a42d97981cb62acce7e6fa69.html">Particle</a>&#160;/&#160;<a class="el" href="Particle_8h.html">Particle.h</a></td><td class="dirtab"><a class="el" href="Mesh_8h.html">Mesh.h</a></td></tr></table></div><!-- contents -->
<h3>inc &rarr; Materials Relation</h3><table class="dirtab"><tr class="dirtab"><th class="dirtab">File in inc</th><th class="dirtab">Includes file in inc/Materials</th></tr><tr class="dirtab"><td class="dirtab"><a class="el" href="dir_f1270302287848fabb3590603b4a7bf4.html">Body</a>&#160;/&#160;<a class="el" href="Body_8h.html">Body.h</a></td><td class="dirtab"><a class="el" href="Material_8h.html">Material.h</a></td></tr><tr class="dirtab"><td class="dirtab"><a class="el" href="Input_8h.html">Input.h</a></td><td class="dirtab"><a class="el" href="Material_8h.html">Material.h</a></td></tr><tr class="dirtab"><td class="dirtab"><a class="el" href="dir_94768b30a42d97981cb62acce7e6fa69.html">Particle</a>&#160;/&#160;<a class="el" href="Particle_8h.html">Particle.h</a></td><td class="dirtab"><a class="el" href="Material_8h.html">Material.h</a></td></tr></table></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
Expand Down
4 changes: 2 additions & 2 deletions docs/dir_000001_000004.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MPM-Geomechanics: inc -&gt; Particle Relation</title>
<title>MPM-Geomechanics: inc -&gt; Mesh Relation</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
Expand Down Expand Up @@ -105,7 +105,7 @@
</div>

<div class="contents">
<h3>inc &rarr; Particle Relation</h3><table class="dirtab"><tr class="dirtab"><th class="dirtab">File in inc</th><th class="dirtab">Includes file in inc/Particle</th></tr><tr class="dirtab"><td class="dirtab"><a class="el" href="dir_f1270302287848fabb3590603b4a7bf4.html">Body</a>&#160;/&#160;<a class="el" href="Body_8h.html">Body.h</a></td><td class="dirtab"><a class="el" href="Particle_8h.html">Particle.h</a></td></tr><tr class="dirtab"><td class="dirtab"><a class="el" href="Output_8h.html">Output.h</a></td><td class="dirtab"><a class="el" href="Particle_8h.html">Particle.h</a></td></tr><tr class="dirtab"><td class="dirtab"><a class="el" href="States_8h.html">States.h</a></td><td class="dirtab"><a class="el" href="Particle_8h.html">Particle.h</a></td></tr><tr class="dirtab"><td class="dirtab"><a class="el" href="dir_508cbffc9888f29a0b75cd03909f2b66.html">Materials</a>&#160;/&#160;<a class="el" href="Elastic_8h.html">Elastic.h</a></td><td class="dirtab"><a class="el" href="Particle_8h.html">Particle.h</a></td></tr></table></div><!-- contents -->
<h3>inc &rarr; Mesh Relation</h3><table class="dirtab"><tr class="dirtab"><th class="dirtab">File in inc</th><th class="dirtab">Includes file in inc/Mesh</th></tr><tr class="dirtab"><td class="dirtab"><a class="el" href="Integration_8h.html">Integration.h</a></td><td class="dirtab"><a class="el" href="Mesh_8h.html">Mesh.h</a></td></tr><tr class="dirtab"><td class="dirtab"><a class="el" href="MPM_8h.html">MPM.h</a></td><td class="dirtab"><a class="el" href="Mesh_8h.html">Mesh.h</a></td></tr><tr class="dirtab"><td class="dirtab"><a class="el" href="Output_8h.html">Output.h</a></td><td class="dirtab"><a class="el" href="Mesh_8h.html">Mesh.h</a></td></tr><tr class="dirtab"><td class="dirtab"><a class="el" href="Update_8h.html">Update.h</a></td><td class="dirtab"><a class="el" href="Mesh_8h.html">Mesh.h</a></td></tr><tr class="dirtab"><td class="dirtab"><a class="el" href="dir_94768b30a42d97981cb62acce7e6fa69.html">Particle</a>&#160;/&#160;<a class="el" href="Particle_8h.html">Particle.h</a></td><td class="dirtab"><a class="el" href="Mesh_8h.html">Mesh.h</a></td></tr></table></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
Expand Down
Loading

0 comments on commit b9d4472

Please sign in to comment.