Yade documnetation

Hello Mohsen,

I'am confused with yade documentation

There are more versions of the documentation, please send a link..

> 1- what is the difference between Class references (chap 8) and modules
> (chap 9)?
>

the main difference is location of the source code. Class reference is
generated from C++ source files, while modules are Python modules located
in different directory

> 2- as an example, in chap 8 one class is (p. 412):
> class yade.wrapper.BodyContainer((object)arg1, (BodyContainer)arg2)
> can anyone explain what is the meaning of each expression:
> i : yade.wrapper
>

yade.wrapper is a Python module created to wrap the C++ part of Yade for
Python

> ii: bodyContainer
>

BodyContainer is class name

     iii: (object)arg1, (BodyContainer)arg2--> why font style of these two
> is italic?
>

it comes from the template, to emphasize that they are input arguments

> iv: arg1, arg2
>

argument1, argument2 :-)
arg1 is always the object itself (like "self" in class definitions in
Python)
other arguments are what the function/class expects, usually also with
type. The very first line of each class is the default constructor. So
BodyContainer expects another BodyContainer as an argument :-) Just to get
an idea (I have never used this code myself) you can try in Yade:

BodyContainer() # results in error complaining about missing argument
BodyContainer(O.bodies) # without error

> 3-In chap 9, in some classes the word 'class' is omitted in other places
> not. why ?(example) :
> yade.pack.gtsSurface2Facets(surf, **kw) (p 440)
> class yade.pack.inGtsSurface_py(inherits Predicate) (p. 441)
>

yade.pack.gtsSurface2Facets(surf, **kw) is just a plain function, not
class, that's the reason

I am not sure if I explained everything understandably, if not, just ask
again :-)
cheers
Jan

hello Jan
thatns you for your consideration

my reference Documentation link:
https://yade-dem.org/doc/Yade.pdf

there are some more ambiguities:

about question 1- : there are some functions in Class references(ch 8) that are repeated in Yade modules (ch9); although they are not the same but i can not understand the difference for a better selecting when coding:
      class yade.wrapper.Sphere((object)arg1) (p.156)
       yade.utils.sphere(center, radius, dynamic=None, fixed=False, wire=False, color=None, highlight= False, material=-1, mask=1) (p. 464)

again such classes could be found about 'tetra'. what is the difference between s1 (an instance of yade.wrapper.Sphere) and s2(an instance of yade.utils.sphere)

2- i found this example on page 6:
Yade [96]: s=utils.sphere(center=[0,0,0],radius=1)
...
Yade [99]: s.shape.radius
...
as i have searched there is no 'radius' method for 'shape' class (p 151). how above command is correct?

thanks Jan

thank you Jan so much
i have to focus on
1- Class reference and modules more; they have confused me.
2- the procedure of creating of a body
thank again

Thanks Jan Stránský, that solved my question.