Marsupilami Documentation - Read the Docs

Marsupilami DocumentationRelease 0.x.0

Lionel du Peloux

November 30, 2015

Contents

1 Overview 31.1 Intro . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31.2 Modèle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31.3 Solver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31.4 Elément . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41.5 Contrainte . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

2 Elements 52.1 Beams . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52.2 Cable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52.3 Bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52.4 Tie . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52.5 Strut . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

3 Constraint 73.1 Intro . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73.2 Link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73.3 Kinematic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73.4 Mechanical . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73.5 Force . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

4 Overview 94.1 Motivating Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94.2 Installation Instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94.3 References . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94.4 Credits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

5 Learning and Teaching 115.1 Simple cable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115.2 Simple Elastica . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115.3 C# API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

6 Theory 136.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136.2 Darboux Vector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136.3 Dynamic relaxation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136.4 Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

7 Overview 15

i

7.1 Get Involved . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157.2 Open source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157.3 Ressources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

8 Html autodoc with sphinx (WIP) 178.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178.2 Environnement Virtuel (python) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178.3 Générer la doc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

9 API doxygen (WIP) 199.1 Test handwritten doc (sphinxcontrib-dotnetdomain) . . . . . . . . . . . . . . . . . . . . . . . . . . . 199.2 Dynamic Relaxation (breathe) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209.3 Element (breathe) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229.4 Utility (breathe) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

10 Indices and tables 25

ii

Marsupilami Documentation, Release 0.x.0

Marsupilami est un solver pour le formfinding et le calcul des structures du Génie Civil basé sur des méthodes dedynamique explicite.

Marsupilami permet de faire aussi bien de la dynamique (avec schéma d’intégration explicite) que du calcul statique(par dynamique explicite amortie, telle la relaxation dynamique avec amortissement cinétique ou visqueux).

Positionnement :

• rigueur scientifique

• open source

• contributif

• hebergé sur GitHub

• documenté sur Read The Docs

• intégration ciblée pour Rhino et Grasshopper

The main documentation for the site is organized into a couple sections:

• Architecture

• User Documentation

• Developer Documentation

Contents 1


2 Contents

CHAPTER 1

Overview

1.1 Intro

Conceptuellement, le système étudié est modélisé comme une “soupe” de points matériels auxquels sont affectés desmasses. L’état du système est suivi au cours du temps. A chaque instant, on connaît pour chaque noeud du système :

• M[i] : sa masse

• X[i] : sa position

• V[i] : sa vitesse

• A[i] : son accélération

• R[i] : la résultante des forces s’appliquant sur ce noeud

• F[i] : les efforts extérieurs s’appliquant sur ce noeud

ToTHINK : pour la torsion, il faut considérer un noeud orienté et un moment de torsion

Ces points matériels, appelés également noeuds, sont liés les uns aux autres par des lois d’interactions ou relations quidéfinissent entre autre :

• des éléments, agissant sur M et R (Beam, Cable, Chain, Bar, Tie, Strut, ...)

• des contraintes cinématiques, agissant sur X et V

• des contraintes méchaniques, agissant sur M et R

• des liaisons, agissant sur X, V, M, R

1.2 Modèle

Faut il définir l’abstraction d’un model ? Un modèle est un ensemble de masses ponctuelles caractérisé par :

• un état initial

• des relations entre les masses ponctuelles

1.3 Solver

Un solver est un code qui permet de faire évoluer un modèle dans le temps, vers un état d’équilibre ou non. element

3


1.4 Elément

Un élément représente une interaction méchanique entre un groupe de noeuds. Cette relation donne lieu à la définitiond’efforts internes qui n’ont de sens que pour l’élément lui même (N, T, M, Q). Du point de vue du système, seul larésultante des efforts en chaque noeud n’a de sens.

Element Node Loop Torsion Flexion Compression TractionTorsion Beam N yes x x x xFlexion Beam N yes x x xCable N yes xSliding Cable N no xBar 2 no x xTie 2 no xStrut 2 no x

Certain éléments peuvent s’utiliser dans une configuration bouclée. D’autres types d’éléments peuvent entrer danscette liste, comme des mailles de fillet ou des éléments de nexorade.

1.5 Contrainte

On regroupe sous l’appelation constraint les autres types de relations entre noeuds.

Constraint Nodes M X V R FLink 1-N X X X XKinematic 1-N X XMechanic 1-N X XForce 1-N X

On peut considérer des actions exterieures qui soient dépendantes de la géométrie (forces suiveuses comme pression /amplitude de chargement fonction d’une déformée) ou du temps (sollicitations dynamiques)

4 Chapter 1. Overview

CHAPTER 2

Elements

2.1 Beams

2.1.1 Torsion Beam

2.1.2 Flexion Beam

2.2 Cable

2.3 Bar

2.4 Tie

2.5 Strut

5


6 Chapter 2. Elements

CHAPTER 3

Constraint

3.1 Intro

3.2 Link

3.3 Kinematic

3.4 Mechanical

3.5 Force

7


8 Chapter 3. Constraint

CHAPTER 4

Overview

Marsupilami is a non linear solver for networks of beams, bars and cables. It is based on a dynamic relaxationalgorithm.

4.1 Motivating Example

using Rhino

x = rand(1000, 1000)r = sum(x, 2)

4.2 Installation Instructions

Marsupilami is a .Net libray written in C#.

It has some dependencies : - Rhinoceros 5 - Grasshopper - Math.NET numerics - Intel MKL

4.3 References

4.4 Credits

Laboratoire Navier

2010 - Lionel du Peloux

9



CHAPTER 5

Learning and Teaching


5.1 Simple cable

using Rhino

x = rand(1000, 1000)r = sum(x, 2)

5.2 Simple Elastica

5.3 C# API

11


12 Chapter 5. Learning and Teaching

CHAPTER 6

Theory


6.1 Overview

Darboux vector Those equations can be formulated with the emph{Darboux vector} of the chosen material frame,which represents the rotational velocity of the frame along 𝑥(𝑠) :

6.2 Darboux Vector

𝑑′𝑖(𝑠) = Ω𝑚(𝑠)× 𝑑𝑖(𝑠) , Ω𝑚(𝑠) =

⎡⎣ 𝜏(𝑠)𝜅1(𝑠)𝜅2(𝑠)

⎤⎦

6.3 Dynamic relaxation

6.4 Elements

13


14 Chapter 6. Theory

CHAPTER 7

Overview

7.1 Get Involved

Directives to contribut. Pull request via GitHub.

7.2 Open source

7.3 Ressources

• GitHub

• Read the doc

• McNeel

15



CHAPTER 8

Html autodoc with sphinx (WIP)

8.1 Introduction

Plusieurs solutions ont été testées pour réaliser une doc automatique façon “API” à partir de sphinx. En effet,sphinx dispose d’un module autodoc mais celui-ci est reservé à python. Cependant, sphinx permet l’ajout dedomain pour cibler d’autres langages. Pour .NET, une tentative existe mais n’est qu’en verison alpha à ce jour :

• sphinxcontrib-dotnetdomain : un domain pour sphinx prenant en charge .Net (édité par RTD)

• sphinx-autoapi : une extension sphinx pour générer de la doc façon “API” automatiquement, avec prise encompte .Net (édité par RTD)

• sphinx-autoapi needs docfx

• breathe : une extension sphinx pour faire le lien entre doxygen et sphinx (actuellement en place, mais orientéC++, ne semble pas très bien adapté pour le C#)

• doxygen : utilitaire avec interface graphique qui permet de générer un autodoc façon “API” à partir d’un codeCsharp. Fonctionne très bien. Pas d’intégration en standard avec sphinx.

• Je devrais jetter un coup d’oeil également à MKDocs

Tout celà fonctionne avec python. Pour s’affranchir de difficultées liées à de multiples installations python, unvirtualenv a été mis en place au sein du dossier manual.

Note: Un virtualenv n’est autre qu’une distribution locale et isolée de python dans laquelle on peut se placerpour travailler. Idéal pour les problèmes liés aux liens symbolics lorsqu’on a de multiples versions de python sur lamême machine.

8.2 Environnement Virtuel (python)

Installer virtualenv pour la distribution python utilisée par défaut pour le système avec pip (la commande sudopermet d’executer la commande avec les privilèges admin si nécessaire):

$ [sudo] pip install virtualenv

Créer un environnement virtuel dans le dossier. ../Marsupilami/doc/manual/_virtualenv avec la com-mande suivante:

$ virtualenv ../Marsupilami/doc/manual/_virtualenv

17

https://github.com/rtfd/sphinxcontrib-dotnetdomain

https://github.com/rtfd/sphinx-autoapi

http://vicancy.github.io/docascode/#/tutorial/docfx_getting_started.md

https://breathe.readthedocs.org/en/latest/

http://www.stack.nl/~dimitri/doxygen/

http://www.mkdocs.org


Se placer dans cet environnement virtuel avec la commande suivante:

$ source ../Marsupilami/doc/manual/_virtualenv/bin/activate

Note: L’invite de commande du terminal change alors de nom pour montrer que les appels pythons se feront désormaisà partir de cet environnement virtuel.

Dans cet envrionnement virtuel, installer les packages requis:

$ pip install sphinx$ pip install breathe$ pip install sphinxcontrib-dotnetdomain$ pip install sphinx-autoapi$ pip install recommonmark

Vérifier les modules installés en appelant la commande:

$ pip list

8.3 Générer la doc

La doc est générée :

• à partir des fichiers .rst du dossier ../Marsupilami/doc/manual/

• à partir des fichiers xml générés par doxygen et situés dans le dossier../Marsupilami/doc/manual/_doxygen/

Un mémo REST est disponible sur RTD.

La génération de la XML doc (et d’un HTML façon “API”) avec doxygen est sans soucis.

La configuration de breathe se fait dans le fichier conf.py du projet sphinx:

extensions = ['sphinx.ext.autodoc','autoapi.extension','sphinxcontrib.dotnetdomain','breathe']breathe_projects = { "Marsupilami": "../manual/_doxygen/xml/" }breathe_default_members = ('members', 'undoc-members','protected-members','private-members')breathe_default_project = 'Marsupilami'

Une fois placé dans l’environnement python virtuel, se placer dans le dossier ../Marsupilami/doc/manual/et invoquer la commande (selon les cas):

$ make html$ make clean html

Autre point d’aide pour breathe : tuto

18 Chapter 8. Html autodoc with sphinx (WIP)

http://rest-sphinx-memo.readthedocs.org/en/latest/index.html

https://github.com/Cruel/readthedocs-breathe/tree/master/docs

CHAPTER 9

API doxygen (WIP)

9.1 Test handwritten doc (sphinxcontrib-dotnetdomain)

This should be available in a near futur with autodoc capabilities with the sphinx-autoapi (WIP).

method(FooType bar)

Arguments

• bar (Bar) – A Bar instance

Returns Altered bar instance

On Foo instance, return Bar instance

class protected static ValidClass

MethodNoArgs()

MethodArg(T1)Arguments

• T1 – Version slug to use for node lookup

MethodArgs(T1, T2)Arguments

• T1 – desciption T1• T2 – desciption T2

method(FooType bar)Arguments

• bar (Bar) – A Bar instanceReturns Altered bar instance

MethodNested(List<int>, Dictionary<string, List<int>>)

Foobar()SetterGetter

Foobar()AdderRemover

namespace ValidNamespace

class ValidClass

19

https://github.com/rtfd/sphinx-autoapi


struct ValidStructure

interface ValidInterface

ValidProperty()

ValidField()

ValidEvent()

ValidOperator()

namespace ValidNamespace

class ValidNamespace.Foobar<T>

class ValidNamespace.Foobar<T,T>

class ValidNamespace.Foobar<TFoo,TBar>

class ValidNamespace.Foobar<T,<string>>

class ValidNamespace.Foobar<T,<T,<string>>>

NestedProperty()

NestedField()

NestedEvent()

NestedOperator()

class ValidNamespace.NestedClass

NestedClassProperty()

NestedClassField()

NestedClassEvent()

NestedClassOperator()

9.2 Dynamic Relaxation (breathe)

class Marsupilami::Kernel::DRRelax

Public Functions

DRRelax(DRElement [] elements, List< DRConstraint > constraints)

void Run()

List<string> Info()

DataTree<Vector3d> GHTree_Xt()

DataTree<Vector3d> GHTree_Xi()

DataTree<Vector3d> GHTree_Vt()

DataTree<Vector3d> GHTree_Rt()

DataTree<Vector3d> GHTree_Fext()

20 Chapter 9. API doxygen (WIP)


DataTree<GH_Number> GHTree_LMt()

DataTree<GH_Number> GHTree_N()

DataTree<GH_Number> GHTree_T()

DataTree<GH_Number> GHTree_M()

Public Members

int numIteration

int numPic

int numCurrentPicIterations

List<int> iterationHistory

List<double> chronoHistory

Stopwatch chrono

Property

property Marsupilami::Kernel::DRRelax::CountElements

property Marsupilami::Kernel::DRRelax::CountNodes

property Marsupilami::Kernel::DRRelax::Ect

property Marsupilami::Kernel::DRRelax::Ec0

property Marsupilami::Kernel::DRRelax::Ec1

property Marsupilami::Kernel::DRRelax::Eclim

property Marsupilami::Kernel::DRRelax::dt

property Marsupilami::Kernel::DRRelax::Fext

property Marsupilami::Kernel::DRRelax::Xi

property Marsupilami::Kernel::DRRelax::Xt

property Marsupilami::Kernel::DRRelax::Vt

property Marsupilami::Kernel::DRRelax::Rt

property Marsupilami::Kernel::DRRelax::LMt

property Marsupilami::Kernel::DRRelax::Elements

Private Functions

void Init()

void Reset()

void InterpolateEc(double E0, double E1, double E2)

void Update_F()

9.2. Dynamic Relaxation (breathe) 21


Private Members

double _Eclim

double _Ect

double _Ec0

double _Ec1

double _dt

int numElements

int numNodes

Vector3d [][] _Xi

Vector3d [][] _Fext

Vector3d [][] _Xt

Vector3d [][] _Vt

Vector3d [][] _Rt

double [][] _LMt

DRElement [] elements

double q

Vector3d [][] Vtmp

DRConstraint [] constraints

DRKinematicConstraint [] kinematicConstraints

DRMechanicalConstraint [] mechanicalConstraints

DRLinkConstraint [] linkConstraints

9.3 Element (breathe)

class Marsupilami::Kernel::DRElement

Public Functions

virtual abstract override string ToString() = 0

virtual abstract void Update_R(ref Vector3d Rt[][], ref Vector3d Fext[][], ref Vector3d Xt[][]) = 0

virtual abstract void Update_LM(ref double LMt[][]) = 0

Vector3d [] X(ref Vector3d Xt[][])

Vector3d [] V(ref Vector3d Vt[][])

Vector3d [] R(ref Vector3d Rt[][])

Vector3d [] F(ref Vector3d Fext[][])

double [] LM(ref double LMt[][])



virtual abstract double [] N() = 0

virtual abstract double [] T() = 0

virtual abstract double [] M() = 0

Property

property Marsupilami::Kernel::DRElement::Count

property Marsupilami::Kernel::DRElement::Index

property Marsupilami::Kernel::DRElement::Name

property Marsupilami::Kernel::DRElement::Type

property Marsupilami::Kernel::DRElement::E

property Marsupilami::Kernel::DRElement::S

property Marsupilami::Kernel::DRElement::I

property Marsupilami::Kernel::DRElement::ES

property Marsupilami::Kernel::DRElement::EI

property Marsupilami::Kernel::DRElement::Xi

property Marsupilami::Kernel::DRElement::L0

property Marsupilami::Kernel::DRElement::Fext

property Marsupilami::Kernel::DRElement::Lt

property Marsupilami::Kernel::DRElement::X12

property Marsupilami::Kernel::DRElement::N12

property Marsupilami::Kernel::DRElement::M12

property Marsupilami::Kernel::DRElement::F1

property Marsupilami::Kernel::DRElement::F2

property Marsupilami::Kernel::DRElement::dt

property Marsupilami::Kernel::DRElement::g

Protected Functions

DRElement(int index, Vector3d[] Xi, double[] L0, Vector3d[] Fext, double dt)

Protected Attributes

double alpha

double k

double lm

9.3. Element (breathe) 23


Private Members

int _numNodes

int _index

ElementTypes _type

string _name

double _E

double _S

double _I

double _ES

double _EI

Vector3d [] _Xi

Vector3d [] _Fext

double [] _L0

double [] _Lt

Vector3d [] _X12

Vector3d [] _N12

Vector3d [] _M12

Vector3d [] _F1

Vector3d [] _F2

double _dt

double _g

9.4 Utility (breathe)

class Marsupilami::Kernel::Utility


CHAPTER 10

Indices and tables

• genindex

• search

25


26 Chapter 10. Indices and tables

Index

Symbols_E (C++ member), 24_EI (C++ member), 24_ES (C++ member), 24_Ec0 (C++ member), 22_Ec1 (C++ member), 22_Eclim (C++ member), 22_Ect (C++ member), 22_I (C++ member), 24_S (C++ member), 24_dt (C++ member), 22, 24_g (C++ member), 24_index (C++ member), 24_name (C++ member), 24_numNodes (C++ member), 24_type (C++ member), 24

Aalpha (C++ member), 23

Cchrono (C++ member), 21chronoHistory (C++ member), 21

GGHTree_Fext (C++ function), 20GHTree_LMt (C++ function), 20GHTree_M (C++ function), 21GHTree_N (C++ function), 21GHTree_Rt (C++ function), 20GHTree_T (C++ function), 21GHTree_Vt (C++ function), 20GHTree_Xi (C++ function), 20GHTree_Xt (C++ function), 20

IInfo (C++ function), 20Init (C++ function), 21InterpolateEc (C++ function), 21iterationHistory (C++ member), 21

Kk (C++ member), 23

Llm (C++ member), 23

MMarsupilami::Kernel::DRElement (C++ class), 22Marsupilami::Kernel::DRRelax (C++ class), 20Marsupilami::Kernel::Utility (C++ class), 24

NNone (Foo.method method), 19None (ValidClass class), 19None (ValidClass.Foobar field), 19None (ValidClass.Foobar property), 19None (ValidClass.method method), 19None (ValidClass.MethodArg method), 19None (ValidClass.MethodArgs method), 19None (ValidClass.MethodNested method), 19None (ValidClass.MethodNoArgs method), 19None (ValidEvent event), 20None (ValidField field), 20None (ValidInterface interface), 20None (ValidNamespace namespace), 19, 20None (ValidNamespace.Foobar<T,<string>> class), 20None (ValidNamespace.Foobar<T,<T,<string>>> class),

20None (ValidNamespace.Foobar<T,T> class), 20None (ValidNamespace.Foobar<T> class), 20None (ValidNamespace.Foobar<TFoo,TBar> class), 20None (ValidNamespace.NestedClass class), 20None (ValidNamespace.NestedClass.NestedClassEvent

event), 20None (ValidNamespace.NestedClass.NestedClassField

field), 20None (ValidNamespace.NestedClass.NestedClassOperator

operator), 20None (ValidNamespace.NestedClass.NestedClassProperty

property), 20

27


None (ValidNamespace.NestedEvent event), 20None (ValidNamespace.NestedField field), 20None (ValidNamespace.NestedOperator operator), 20None (ValidNamespace.NestedProperty property), 20None (ValidOperator operator), 20None (ValidProperty property), 20None (ValidStructure structure), 19numCurrentPicIterations (C++ member), 21numElements (C++ member), 22numIteration (C++ member), 21numNodes (C++ member), 22numPic (C++ member), 21

Qq (C++ member), 22

RReset (C++ function), 21Run (C++ function), 20

UUpdate_F (C++ function), 21

28 Index

Documents

Marsupilami Documentation - Read the Docs