Skip to content

Commit a80f9dd

Browse files
Rtd Integration (#75)
* Modify Doxyfile to generate xml * Revert "Modify Doxyfile to generate xml" This reverts commit 4f047c4. * Fix encoding and symbols * Modified documentation. Now builds current documentation in sphinx. * Fix unknown symbols
1 parent f6effd5 commit a80f9dd

File tree

14 files changed

+2688
-14
lines changed

14 files changed

+2688
-14
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ pip install pysplishsplash
4040
```
4141
These are available for Python Versions: 2.7, 3.5, 3.6, 3.7, 3.8.
4242
If you do not meet these conditions please refer to the build instructions and to the python binding
43-
[Getting started guide](https://github.com/InteractiveComputerGraphics/SPlisHSPlasH/blob/master/doc/pysplishsplash/getting_started.md).
43+
[Getting started guide](https://github.com/InteractiveComputerGraphics/SPlisHSPlasH/blob/master/doc/py_getting_started.md).
4444

4545
The command line simulator is available by running one of the following
4646
```
@@ -55,9 +55,9 @@ splash --help
5555
* [CMake Options](https://github.com/InteractiveComputerGraphics/SPlisHSPlasH/blob/master/doc/cmake_options.md)
5656
* [SPH tutorial](https://interactivecomputergraphics.github.io/SPH-Tutorial)
5757
* Python binding:
58-
* [Getting started](https://github.com/InteractiveComputerGraphics/SPlisHSPlasH/blob/master/doc/pysplishsplash/getting_started.md)
59-
* [Creating scenes](https://github.com/InteractiveComputerGraphics/SPlisHSPlasH/blob/master/doc/pysplishsplash/creating_scenes.md)
60-
* [Restrictions](https://github.com/InteractiveComputerGraphics/SPlisHSPlasH/blob/master/doc/pysplishsplash/restrictions.md)
58+
* [Getting started](https://github.com/InteractiveComputerGraphics/SPlisHSPlasH/blob/master/doc/py_getting_started.md)
59+
* [Creating scenes](https://github.com/InteractiveComputerGraphics/SPlisHSPlasH/blob/master/doc/py_creating_scenes.md)
60+
* [Restrictions](https://github.com/InteractiveComputerGraphics/SPlisHSPlasH/blob/master/doc/py_restrictions.md)
6161
* The API documentation can be found here: http://www.interactive-graphics.de/SPlisHSPlasH/doc/html
6262

6363
## Features

SPlisHSPlasH/Elasticity/Elasticity_Becker2009.cpp

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -273,9 +273,9 @@ void Elasticity_Becker2009::computeForces()
273273
if (m_alpha != 0.0)
274274
{
275275
//////////////////////////////////////////////////////////////////////////
276-
// Ganzenmüller, G.C. 2015. An hourglass control algorithm for Lagrangian
276+
// Ganzenmüller, G.C. 2015. An hourglass control algorithm for Lagrangian
277277
// Smooth Particle Hydrodynamics. Computer Methods in Applied Mechanics and
278-
// Engineering 286, 87–106.
278+
// Engineering 286, 87.106.
279279
//////////////////////////////////////////////////////////////////////////
280280
Vector3r fi_hg;
281281
fi_hg.setZero();
@@ -289,12 +289,12 @@ void Elasticity_Becker2009::computeForces()
289289
const Vector3r &xj = model->getPosition(neighborIndex);
290290
const Vector3r &xj0 = m_model->getPosition0(neighborIndex0);
291291

292-
// Note: Ganzenmüller defines xij = xj-xi
292+
// Note: Ganzenm�ller defines xij = xj-xi
293293
const Vector3r xi_xj = -(xi - xj);
294294
const Real xixj_l = xi_xj.norm();
295295
if (xixj_l > 1.0e-6)
296296
{
297-
// Note: Ganzenmüller defines xij = xj-xi
297+
// Note: Ganzenm�ller defines xij = xj-xi
298298
const Vector3r xi_xj_0 = -(xi0 - xj0);
299299
const Real xixj0_l2 = xi_xj_0.squaredNorm();
300300
const Real W0 = sim->W(xi_xj_0);

SPlisHSPlasH/Elasticity/Elasticity_Peer2018.cpp

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -400,9 +400,9 @@ void Elasticity_Peer2018::computeRHS(VectorXr & rhs)
400400
if (m_alpha != 0.0)
401401
{
402402
//////////////////////////////////////////////////////////////////////////
403-
// Ganzenmüller, G.C. 2015. An hourglass control algorithm for Lagrangian
403+
// Ganzenmüller, G.C. 2015. An hourglass control algorithm for Lagrangian
404404
// Smooth Particle Hydrodynamics. Computer Methods in Applied Mechanics and
405-
// Engineering 286, 87–106.
405+
// Engineering 286, 87.106.
406406
//////////////////////////////////////////////////////////////////////////
407407
Vector3r fi_hg;
408408
fi_hg.setZero();
@@ -416,12 +416,12 @@ void Elasticity_Peer2018::computeRHS(VectorXr & rhs)
416416
const Vector3r &xj = model->getPosition(neighborIndex);
417417
const Vector3r &xj0 = m_model->getPosition0(neighborIndex0);
418418

419-
// Note: Ganzenmüller defines xij = xj-xi
419+
// Note: Ganzenm�ller defines xij = xj-xi
420420
const Vector3r xi_xj = -(xi - xj);
421421
const Real xixj_l = xi_xj.norm();
422422
if (xixj_l > 1.0e-6)
423423
{
424-
// Note: Ganzenmüller defines xij = xj-xi
424+
// Note: Ganzenm�ller defines xij = xj-xi
425425
const Vector3r xi_xj_0 = -(xi0 - xj0);
426426
const Real xixj0_l2 = xi_xj_0.squaredNorm();
427427
const Real W0 = sim->W(xi_xj_0);

SPlisHSPlasH/Utilities/MathFunctions.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ namespace SPH
1010
{
1111
public:
1212
/** Implementation of the paper: \n
13-
* Matthias Müller, Jan Bender, Nuttapong Chentanez and Miles Macklin,
13+
* Matthias Müller, Jan Bender, Nuttapong Chentanez and Miles Macklin,
1414
* "A Robust Method to Extract the Rotational Part of Deformations",
1515
* ACM SIGGRAPH Motion in Games, 2016
1616
*/

0 commit comments

Comments
 (0)