Diffusion GooseFEM f64ccfd6ac5d

Minimal documentation (#31)
f64ccfd6ac5d
Actions

Authored by tdegeus on Oct 8 2019, 20:14.

Description

Minimal documentation (#31)

Minimal documentation
Added todos in docs
Allowing Eigen's Sparse Solver Concept.
Updating ParaView
Updating code-style
Completed Python interface
Python example

Details

Committed

GitHub <noreply@github.com>

Oct 8 2019, 20:14

Parents

rGOOSEFEM37fcb586f340: Merge pull request #32 from tdegeus/solver

Branches

Unknown

Tags

Unknown

Event Timeline

GitHub <noreply@github.com> committed rGOOSEFEMf64ccfd6ac5d: Minimal documentation (#31) (authored by tdegeus).Oct 8 2019, 20:14

Changes (205)
Show All Changes

Very Large Commit

This commit is very large. Load each file individually.

		Path
M		.travis.yml
M		README.md
D		docs/Element.rst
V		docs/{ → details}/Matrix.rst
D		docs/Mesh.rst
V		docs/{ → details}/ParaView.rst
D		docs/Vector.rst
M		docs/compile.rst
M		docs/conf.py
A	(dir)	docs/conventions/
A		docs/conventions/allocation.rst
A	(dir)	docs/conventions/figures/
A		docs/conventions/figures/data-representation.idraw
A		docs/conventions/figures/data-representation.svg
A		docs/conventions/matrix.rst
A		docs/conventions/storage.rst
A		docs/conventions/terminology.rst
A		docs/conventions/vector.rst
A		docs/details/Element.rst
A		docs/details/ElementHex8.rst
A		docs/details/ElementQuad4.rst
A		docs/details/Iterate.rst
V		docs/{details ← }/Matrix.rst
A		docs/details/Mesh.rst
A		docs/details/MeshHex8.rst
M		docs/details/MeshQuad4.rst
A		docs/details/MeshTri3.rst
V		docs/{details ← }/ParaView.rst
A		docs/details/Tyings.rst
A		docs/details/Vector.rst
A	(dir)	docs/details/figures/MeshHex8/
A	(dir)	docs/details/figures/MeshHex8/FineLayer/
V		docs/{details/figures/MeshHex8/FineLayer/example.py ← examples/Mesh/MeshHex8-FineLayer.py}
V		docs/{details/figures/MeshHex8/FineLayer/nodes.py ← examples/Mesh/MeshHex8-FineLayer-nodes.py}
A	(dir)	docs/details/figures/MeshHex8/Regular/
V		docs/{details/figures/MeshHex8/Regular/example.py ← examples/Mesh/MeshHex8-Regular.py}
V		docs/{details/figures/MeshHex8/Regular/nodes.py ← examples/Mesh/MeshHex8-Regular-nodes.py}
V		docs/{details ← }/figures/MeshHex8/naming_convention.svg
V		docs/{details/figures/MeshQuad4/FineLayer/behaviour.py ← figures/MeshQuad4/FineLayer/behavior.py}
V		docs/{details/figures/MeshQuad4/FineLayer/behaviour.svg ← figures/MeshQuad4/FineLayer/behavior.svg}
V		docs/{details ← }/figures/MeshQuad4/FineLayer/example.py
V		docs/{details ← }/figures/MeshQuad4/FineLayer/example.svg
V		docs/{details/figures/MeshQuad4/FineLayer/example2.py ← examples/Mesh/MeshQuad4-FineLayer.py}
V		docs/{details/figures/MeshQuad4/FineLayer/nodes.py ← examples/Mesh/MeshQuad4-FineLayer-nodes.py}
A	(dir)	docs/details/figures/MeshQuad4/Regular/
V		docs/{details ← }/figures/MeshQuad4/Regular/example.py
V		docs/{details ← }/figures/MeshQuad4/Regular/example.svg
V		docs/{details/figures/MeshQuad4/Regular/example2.py ← examples/Mesh/MeshQuad4-Regular.py}
V		docs/{details/figures/MeshQuad4/Regular/nodes.py ← examples/Mesh/MeshQuad4-Regular-nodes.py}
V		docs/{details ← }/figures/MeshQuad4/naming_convention.svg
V		docs/{details/figures/MeshTri3/Regular/example2.py ← examples/Mesh/MeshTri3-Regular.py}
V		docs/{details/figures/MeshTri3/Regular/nodes.py ← examples/Mesh/MeshTri3-Regular-nodes.py}
V	(dir)	docs/{details/figures/ParaView/ ← examples/ParaView}
V	(dir)	docs/{details/figures/ParaView/HDF5/ ← examples/ParaView/HDF5}
V		docs/{details/figures ← examples}/ParaView/HDF5/CMakeLists.txt
V		docs/{details/figures ← examples}/ParaView/HDF5/main.cpp
V		docs/{details/figures ← examples}/ParaView/HDF5/main.py
A		docs/details/macros.rst
M		docs/develop.rst
D		docs/examples/Dynamics
D		docs/examples/Dynamics/laminateElastic
D		docs/examples/Dynamics/laminateElastic/noDamping
P		docs/examples/Dynamics/laminateElastic/noDamping/CMakeLists.txt Deleted after being copied to multiple locations: docs/examples/dynamics/Elastic-VelocityVerlet/CMakeLists.txt docs/examples/statics/FixedDisplacements_LinearElastic/example/CMakeLists.txt docs/examples/statics/FixedDisplacements_LinearElastic/manual_partition/CMakeLists.txt docs/examples/statics/Periodic_NonLinearElastic/CMakeLists.txt
V		docs/examples/{Dynamics/laminateElastic/noDamping → dynamics/Elastic-Verlet}/main.cpp
V		docs/examples/{Dynamics/laminateElastic/noDamping/main_velocityVerlet.cpp → dynamics/Elastic-VelocityVerlet/main.cpp}
D		docs/examples/Dynamics/laminateElastic/noDamping/plot.py
D		docs/examples/Dynamics/readme.rst
D		docs/examples/Mesh
D		docs/examples/Mesh/.gitignore
V		docs/{examples/Mesh/MeshHex8-FineLayer-nodes.py → details/figures/MeshHex8/FineLayer/nodes.py}
V		docs/{examples/Mesh/MeshHex8-FineLayer.py → details/figures/MeshHex8/FineLayer/example.py}
V		docs/{examples/Mesh/MeshHex8-Regular-nodes.py → details/figures/MeshHex8/Regular/nodes.py}
V		docs/{examples/Mesh/MeshHex8-Regular.py → details/figures/MeshHex8/Regular/example.py}
V		docs/{examples/Mesh/MeshQuad4-FineLayer-nodes.py → details/figures/MeshQuad4/FineLayer/nodes.py}
V		docs/{examples/Mesh/MeshQuad4-FineLayer.py → details/figures/MeshQuad4/FineLayer/example2.py}
V		docs/{examples/Mesh/MeshQuad4-Regular-nodes.py → details/figures/MeshQuad4/Regular/nodes.py}
V		docs/{examples/Mesh/MeshQuad4-Regular.py → details/figures/MeshQuad4/Regular/example2.py}
V		docs/{examples/Mesh/MeshTri3-Regular-nodes.py → details/figures/MeshTri3/Regular/nodes.py}
V		docs/{examples/Mesh/MeshTri3-Regular.py → details/figures/MeshTri3/Regular/example2.py}
V	(dir)	docs/{examples/ParaView/ → details/figures/ParaView}
V	(dir)	docs/{examples/ParaView/HDF5/ → details/figures/ParaView/HDF5}
V		docs/{examples → details/figures}/ParaView/HDF5/CMakeLists.txt
V		docs/{examples → details/figures}/ParaView/HDF5/main.cpp
V		docs/{examples → details/figures}/ParaView/HDF5/main.py
D		docs/examples/Statics
D		docs/examples/Statics/FixedDisplacements
D		docs/examples/Statics/FixedDisplacements/LinearElasticity
D		docs/examples/Statics/FixedDisplacements/LinearElasticity/CMakeLists.txt
V		docs/examples/{Statics/FixedDisplacements/LinearElasticity → statics/FixedDisplacements_LinearElastic/example}/main.cpp
V		docs/examples/{Statics/FixedDisplacements/LinearElasticity/main_manualPartition.cpp → statics/FixedDisplacements_LinearElastic/manual_partition/main.cpp}
P		docs/examples/Statics/FixedDisplacements/LinearElasticity/plot.py Deleted after being copied to multiple locations: docs/examples/statics/FixedDisplacements_LinearElastic/example/plot.py docs/examples/statics/MixedPeriodic_LinearElastic/plot.py
D		docs/examples/Statics/Periodic
V	(dir)	docs/examples/{Statics/Periodic/ElastoPlasticFiniteStrainSimo/ → statics/Periodic_ElastoPlasticFiniteStrainSimo}
V		docs/examples/{Statics/Periodic/ElastoPlasticFiniteStrainSimo → statics/Periodic_ElastoPlasticFiniteStrainSimo}/CMakeLists.txt
V		docs/examples/{Statics/Periodic/ElastoPlasticFiniteStrainSimo → statics/Periodic_ElastoPlasticFiniteStrainSimo}/main.cpp
V		docs/examples/{Statics/Periodic/ElastoPlasticFiniteStrainSimo → statics/Periodic_ElastoPlastic}/plot.py
V	(dir)	docs/examples/{Statics/Periodic/ElastoPlasticity/ → statics/Periodic_ElastoPlastic}
V		docs/examples/{Statics/Periodic/ElastoPlasticity → dynamics/Elastic-Verlet}/CMakeLists.txt
V		docs/examples/{Statics/Periodic/ElastoPlasticity → statics/Periodic_ElastoPlastic}/main.cpp
V		docs/examples/{Statics/Periodic/ElastoPlasticity → statics/Periodic_ElastoPlasticFiniteStrainSimo}/plot.py
V	(dir)	docs/examples/{Statics/Periodic/LinearElasticity/ → statics/Periodic_LinearElastic}
V		docs/examples/{Statics/Periodic/LinearElasticity → statics/MixedPeriodic_LinearElastic}/CMakeLists.txt
V		docs/examples/{Statics/Periodic/LinearElasticity → statics/Periodic_LinearElastic}/main.cpp
V		docs/examples/{Statics/Periodic/LinearElasticity → statics/Periodic_LinearElastic}/plot.py
V	(dir)	docs/examples/{Statics/Periodic/NonLinearElasticity/ → statics/Periodic_NonLinearElastic}
V		docs/examples/{Statics/Periodic/NonLinearElasticity → statics/Periodic_ElastoPlastic}/CMakeLists.txt
V		docs/examples/{Statics/Periodic/NonLinearElasticity → statics/Periodic_NonLinearElastic}/main.cpp
V		docs/examples/{Statics/Periodic/NonLinearElasticity → statics/Periodic_NonLinearElastic}/plot.py
D		docs/examples/Statics/PeriodicPartial
V	(dir)	docs/examples/{Statics/PeriodicPartial/LinearElasticity/ → statics/MixedPeriodic_LinearElastic}
V		docs/examples/{Statics/PeriodicPartial/LinearElasticity → statics/Periodic_LinearElastic}/CMakeLists.txt
V		docs/examples/{Statics/PeriodicPartial/LinearElasticity → statics/MixedPeriodic_LinearElastic}/main.cpp
V		docs/examples/{Statics/PeriodicPartial/LinearElasticity → statics/FixedDisplacements_LinearElastic/manual_partition}/plot.py
A	(dir)	docs/examples/dynamics/
A	(dir)	docs/examples/dynamics/Elastic-VelocityVerlet/
P		docs/examples/dynamics/Elastic-VelocityVerlet/CMakeLists.txt Copied from docs/examples/Dynamics/laminateElastic/noDamping/CMakeLists.txt
V		docs/examples/{dynamics/Elastic-VelocityVerlet/main.cpp ← Dynamics/laminateElastic/noDamping/main_velocityVerlet.cpp}
A		docs/examples/dynamics/Elastic-VelocityVerlet/plot.py
A	(dir)	docs/examples/dynamics/Elastic-Verlet/
V		docs/examples/{dynamics/Elastic-Verlet ← Statics/Periodic/ElastoPlasticity}/CMakeLists.txt
V		docs/examples/{dynamics/Elastic-Verlet ← Dynamics/laminateElastic/noDamping}/main.cpp
A		docs/examples/dynamics/Elastic-Verlet/plot.py
A		docs/examples/dynamics_inertia-damping.rst
A		docs/examples/dynamics_inertia.rst
A		docs/examples/dynamics_overdamped.rst
A	(dir)	docs/examples/statics/
A	(dir)	docs/examples/statics/FixedDisplacements_LinearElastic/
A	(dir)	docs/examples/statics/FixedDisplacements_LinearElastic/example/
P		docs/examples/statics/FixedDisplacements_LinearElastic/example/CMakeLists.txt Copied from docs/examples/Dynamics/laminateElastic/noDamping/CMakeLists.txt
V		docs/examples/{statics/FixedDisplacements_LinearElastic/example ← Statics/FixedDisplacements/LinearElasticity}/main.cpp
A		docs/examples/statics/FixedDisplacements_LinearElastic/example/main.py
P		docs/examples/statics/FixedDisplacements_LinearElastic/example/plot.py Copied from docs/examples/Statics/FixedDisplacements/LinearElasticity/plot.py
A	(dir)	docs/examples/statics/FixedDisplacements_LinearElastic/manual_partition/
P		docs/examples/statics/FixedDisplacements_LinearElastic/manual_partition/CMakeLists.txt Copied from docs/examples/Dynamics/laminateElastic/noDamping/CMakeLists.txt
V		docs/examples/{statics/FixedDisplacements_LinearElastic/manual_partition/main.cpp ← Statics/FixedDisplacements/LinearElasticity/main_manualPartition.cpp}
A		docs/examples/statics/FixedDisplacements_LinearElastic/manual_partition/main.py
V		docs/examples/{statics/FixedDisplacements_LinearElastic/manual_partition ← Statics/PeriodicPartial/LinearElasticity}/plot.py
A		docs/examples/statics/FixedDisplacements_LinearElastic/problem-sketch.idraw
A		docs/examples/statics/FixedDisplacements_LinearElastic/problem-sketch.svg
V	(dir)	docs/examples/{statics/MixedPeriodic_LinearElastic/ ← Statics/PeriodicPartial/LinearElasticity}
V		docs/examples/{statics/MixedPeriodic_LinearElastic ← Statics/Periodic/LinearElasticity}/CMakeLists.txt
V		docs/examples/{statics/MixedPeriodic_LinearElastic ← Statics/PeriodicPartial/LinearElasticity}/main.cpp
V		docs/examples/{statics/MixedPeriodic_LinearElastic ← Statics/FixedDisplacements/LinearElasticity}/plot.py
V	(dir)	docs/examples/{statics/Periodic_ElastoPlastic/ ← Statics/Periodic/ElastoPlasticity}
V		docs/examples/{statics/Periodic_ElastoPlastic ← Statics/Periodic/NonLinearElasticity}/CMakeLists.txt
V		docs/examples/{statics/Periodic_ElastoPlastic ← Statics/Periodic/ElastoPlasticity}/main.cpp
V		docs/examples/{statics/Periodic_ElastoPlastic ← Statics/Periodic/ElastoPlasticFiniteStrainSimo}/plot.py
V	(dir)	docs/examples/{statics/Periodic_ElastoPlasticFiniteStrainSimo/ ← Statics/Periodic/ElastoPlasticFiniteStrainSimo}
V		docs/examples/{statics/Periodic_ElastoPlasticFiniteStrainSimo ← Statics/Periodic/ElastoPlasticFiniteStrainSimo}/CMakeLists.txt
V		docs/examples/{statics/Periodic_ElastoPlasticFiniteStrainSimo ← Statics/Periodic/ElastoPlasticFiniteStrainSimo}/main.cpp
V		docs/examples/{statics/Periodic_ElastoPlasticFiniteStrainSimo ← Statics/Periodic/ElastoPlasticity}/plot.py
V	(dir)	docs/examples/{statics/Periodic_LinearElastic/ ← Statics/Periodic/LinearElasticity}
V		docs/examples/{statics/Periodic_LinearElastic ← Statics/PeriodicPartial/LinearElasticity}/CMakeLists.txt
V		docs/examples/{statics/Periodic_LinearElastic ← Statics/Periodic/LinearElasticity}/main.cpp
V		docs/examples/{statics/Periodic_LinearElastic ← Statics/Periodic/LinearElasticity}/plot.py
V	(dir)	docs/examples/{statics/Periodic_NonLinearElastic/ ← Statics/Periodic/NonLinearElasticity}
V		docs/examples/{statics/Periodic_NonLinearElastic ← Dynamics/laminateElastic/noDamping}/CMakeLists.txt
V		docs/examples/{statics/Periodic_NonLinearElastic ← Statics/Periodic/NonLinearElasticity}/main.cpp
V		docs/examples/{statics/Periodic_NonLinearElastic ← Statics/Periodic/NonLinearElasticity}/plot.py
A		docs/examples/statics_linear.rst
D		docs/figures
D		docs/figures/MeshHex8
V		docs/{ → details}/figures/MeshHex8/naming_convention.svg
D		docs/figures/MeshQuad4
D		docs/figures/MeshQuad4/FineLayer
V		docs/{figures/MeshQuad4/FineLayer/behavior.py → details/figures/MeshQuad4/FineLayer/behaviour.py}
V		docs/{figures/MeshQuad4/FineLayer/behavior.svg → details/figures/MeshQuad4/FineLayer/behaviour.svg}
V		docs/{ → details}/figures/MeshQuad4/FineLayer/example.py
V		docs/{ → details}/figures/MeshQuad4/FineLayer/example.svg
D		docs/figures/MeshQuad4/Regular
V		docs/{ → details}/figures/MeshQuad4/Regular/example.py
V		docs/{ → details}/figures/MeshQuad4/Regular/example.svg
V		docs/{ → details}/figures/MeshQuad4/naming_convention.svg
M		docs/index.rst
A		docs/introduction.rst
M		include/GooseFEM/Element.h
M		include/GooseFEM/ElementHex8.hpp
M		include/GooseFEM/ElementQuad4.hpp
M		include/GooseFEM/ElementQuad4Axisymmetric.hpp
M		include/GooseFEM/ElementQuad4Planar.hpp
M		include/GooseFEM/Matrix.hpp
M		include/GooseFEM/MatrixDiagonal.hpp
M		include/GooseFEM/MatrixDiagonalPartitioned.hpp
M		include/GooseFEM/MatrixPartitioned.hpp
M		include/GooseFEM/MeshHex8.hpp
M		include/GooseFEM/MeshTri3.hpp
M		include/GooseFEM/Vector.hpp
M		include/GooseFEM/VectorPartitioned.h
M		include/GooseFEM/VectorPartitioned.hpp
M		python/Element.hpp
M		python/ElementHex8.hpp
M		python/ElementQuad4.hpp
A		python/ElementQuad4Axisymmetric.hpp
A		python/ElementQuad4Planar.hpp
M		python/MatrixDiagonalPartitioned.hpp
A		python/MatrixPartitioned.hpp
M		python/Mesh.hpp
M		python/MeshHex8.hpp
M		python/MeshQuad4.hpp
M		python/MeshTri3.hpp
M		python/ParaView.hpp
M		python/Vector.hpp
M		python/VectorPartitioned.hpp
M		python/main.cpp
M		test/MeshQuad4.cpp