/usr/lib/python2.7/dist-packages/woo/utils.py is in python-woo 1.0+dfsg1-1+b4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 | # encoding: utf-8
#
# utility functions for woo
#
# 2008-2009 © Václav Šmilauer <eudoxos@arcig.cz>
"""Heap of functions that don't (yet) fit anywhere else.
"""
import math,random,doctest
import woo, woo.dem, woo.core
import sys,os,warnings
from minieigen import *
from woo.dem import *
from woo.fem import *
from woo.core import *
import woo
import woo.config
# c++ implementations for performance reasons
#from woo._utils import *
#from woo._utils2 import *
from woo._utils2 import *
# declare that _utils2 should be documented here
_docInlineModules=(woo._utils2,)
inf=float('inf')
py3k=(sys.version_info[0]==3)
# try at import time, this is expensive
hasGL=True
try: import woo.gl
except ImportError: hasGL=False
def spherePWaveDt(radius,density,young):
r"""Compute P-wave critical timestep for a single (presumably representative) sphere, using formula for P-Wave propagation speed :math:`\Delta t_{c}=\frac{r}{\sqrt{E/\rho}}`. If you want to compute minimum critical timestep for all spheres in the simulation, use :obj:`woo.utils.pWaveDt` instead.
>>> spherePWaveDt(1e-3,2400,30e9)
2.8284271247461903e-07
"""
from math import sqrt
return radius/sqrt(young/density)
def defaultMaterial():
"""Return default material, when creating particles with :obj:`woo.utils.sphere` and friends and material is unspecified. This function returns ``FrictMat(density=1e3,young=1e7,ktDivKn=.2,tanPhi=tan(.5))``.
"""
import math
return FrictMat(density=1e3,young=1e7,ktDivKn=.2,tanPhi=math.tan(.5))
def defaultEngines(damping=0.,gravity=None,verletDist=-.05,kinSplit=False,dontCollect=False,noSlip=False,noBreak=False,cp2=None,law=None,model=None,grid=False,dynDtPeriod=100,cpKw={},lawKw={}):
"""Return default set of engines, suitable for basic simulations during testing."""
if gravity: raise ValueError("gravity MUST NOT be specified anymore, set DemField.gravity=... instead.")
if model:
if cp2 or law: warnings.warn("cp2 and law args are ignored when model is provided.")
if damping!=0.: warnings.warn("damping is ignored when model is provided.")
cp2,law=model.getFunctors()
if len(law)==1: law[0].label='contactLaw'
if len(cp2)==1: cp2[0].label='cp2'
damping=model.getNonviscDamping()
distFactor=model.distFactor
else:
cp2=[cp2 if cp2 else Cp2_FrictMat_FrictPhys()]
law=[law if law else Law2_L6Geom_FrictPhys_IdealElPl(noSlip=noSlip,noBreak=noBreak,label='contactLaw')]
distFactor=1.
cp2[0].updateAttrs(cpKw)
law[0].updateAttrs(lawKw)
if not grid: collider=InsertionSortCollider([Bo1_Sphere_Aabb(distFactor=distFactor),Bo1_Facet_Aabb(),Bo1_Wall_Aabb(),Bo1_InfCylinder_Aabb(),Bo1_Ellipsoid_Aabb(),Bo1_Rod_Aabb()]+([] if 'nocapsule' in woo.config.features else [Bo1_Capsule_Aabb()]),label='collider',verletDist=verletDist)
else: collider=GridCollider([Grid1_Sphere(),Grid1_Facet(),Grid1_Wall(),Grid1_InfCylinder()],label='collider',verletDist=verletDist)
return [
Leapfrog(damping=damping,reset=True,kinSplit=kinSplit,dontCollect=dontCollect,label='leapfrog'),
collider,
ContactLoop(
[Cg2_Sphere_Sphere_L6Geom(distFactor=distFactor),Cg2_Facet_Sphere_L6Geom(),Cg2_Wall_Sphere_L6Geom(),Cg2_InfCylinder_Sphere_L6Geom(),Cg2_Ellipsoid_Ellipsoid_L6Geom(),Cg2_Sphere_Ellipsoid_L6Geom(),Cg2_Wall_Ellipsoid_L6Geom(),Cg2_Wall_Facet_L6Geom(),Cg2_Rod_Sphere_L6Geom()]+([] if 'nocapsule' in woo.config.features else [Cg2_Wall_Capsule_L6Geom(),Cg2_Capsule_Capsule_L6Geom(),Cg2_InfCylinder_Capsule_L6Geom(),Cg2_Facet_Capsule_L6Geom(),Cg2_Sphere_Capsule_L6Geom(),Cg2_Facet_Facet_L6Geom(),Cg2_Facet_InfCylinder_L6Geom()]),
cp2,law,applyForces=True,label='contactLoop'
),
]+([woo.dem.DynDt(stepPeriod=dynDtPeriod,label='dynDt')] if dynDtPeriod>0 else [])
def _commonBodySetup(b,nodes,mat,fixed=False):
"""Assign common body parameters."""
if isinstance(mat,Material): b.mat=mat
elif callable(mat): b.mat=mat()
else: raise TypeError("The 'mat' argument must be Material instance, or a callable returning Material.");
b.shape.nodes=nodes
if len(nodes)==1:
b.updateMassInertia()
else:
for n in b.shape.nodes:
n.mass=0; n.inertia=Vector3.Zero
for i,n in enumerate(b.nodes):
n.dem.addParRef(b) # tell the node that it has that particle
if fixed==None: pass # do not modify blocked at all
elif fixed==True: n.dem.blocked='xyzXYZ'
else: n.dem.blocked=''.join(['XYZ'[ax] for ax in (0,1,2) if n.dem.inertia[ax]==inf]) # block rotational DOFs where inertia is infinite
def _mkDemNode(**kw):
'''Helper function to create new Node instance, with dem set to an new empty instance.'''
if hasGL: return Node(dem=DemData(),gl=woo.gl.GlData(),**kw)
else: return Node(dem=DemData(),**kw)
def sphere(center,radius,mat=defaultMaterial,fixed=False,wire=False,color=None,highlight=False,mask=DemField.defaultMovableMask):
"""Create sphere with given parameters; mass and inertia computed automatically.
:param Vector3 center: center
:param float radius: radius
:param float-or-None: particle's color as float; random color will be assigned if ``None``.
:param mat:
specify :obj:`woo.dem.Particle.material`; different types are accepted:
* :obj:`woo.dem.Material` instance: this instance will be used
* callable: will be called without arguments; returned Material value will be used (Material factory object, if you like)
:param int mask: :obj:`woo.dem.Particle.mask` for the body
:return:
Particle instance with desired characteristics.
Instance of material can be given::
>>> from woo import utils
>>> s1=utils.sphere((0,0,0),1,wire=False,color=.7,mat=ElastMat(young=30e9,density=2e3))
>>> s1.shape.wire
False
>>> s1.shape.color
0.7
>>> s1.mat.density
2000.0
Finally, material can be a callable object (taking no arguments), which returns a Material instance.
Use this if you don't call this function directly (for instance, through woo.pack.randomDensePack), passing
only 1 *material* parameter, but you don't want material to be shared.
For instance, randomized material properties can be created like this:
>>> import random
>>> def matFactory(): return ElastMat(young=1e10*random.random(),density=1e3+1e3*random.random())
...
>>> s2=utils.sphere([0,2,0],1,mat=matFactory)
>>> s3=utils.sphere([1,2,0],1,mat=matFactory)
"""
b=Particle()
b.shape=Sphere(radius=radius,color=color if color else random.random())
b.shape.wire=wire
_commonBodySetup(b,([center] if isinstance(center,Node) else [_mkDemNode(pos=center),]),mat=mat,fixed=fixed)
b.aspherical=False
b.mask=mask
return b
def ellipsoid(center,semiAxes,ori=Quaternion.Identity,angVel=None,color=None,mat=defaultMaterial,fixed=False,wire=False,visible=True,mask=DemField.defaultMovableMask,**kw):
'Return an :obj:`woo.dem.Ellipsoid` particle.'
p=Particle()
p.shape=Ellipsoid(semiAxes=semiAxes,color=color if color else random.random())
_commonBodySetup(p,([center] if isinstance(center,Node) else [_mkDemNode(pos=center,ori=ori),]),mat=mat,fixed=fixed)
p.shape.wire=wire
p.aspherical=True
p.mask=mask
p.shape.visible=visible
if angVel: p.shape.nodes[0].dem.angVel=angVel
return p
def capsule(center,radius,shaft,ori=Quaternion.Identity,fixed=False,color=None,wire=False,mat=defaultMaterial,mask=DemField.defaultMovableMask):
'Return a ready-made capsule particle.'
p=Particle()
p.shape=Capsule(radius=radius,shaft=shaft,color=color if color else random.random())
_commonBodySetup(p,([center] if isinstance(center,Node) else [_mkDemNode(pos=center,ori=ori),]),mat=mat,fixed=fixed)
p.shape.wire=wire
p.aspherical=True
p.mask=mask
return p
def wall(position,axis,sense=0,glAB=None,fixed=True,mass=0,color=None,mat=defaultMaterial,visible=True,mask=DemField.defaultBoundaryMask):
"""Return ready-made wall body.
:param float-or-Vector3-or-Node position: center of the wall. If float, it is the position along given axis, the other 2 components being zero
:param ∈{0,1,2} axis: orientation of the wall normal (0,1,2) for x,y,z (sc. planes yz, xz, xy)
:param ∈{-1,0,1} sense: sense in which to interact (0: both, -1: negative, +1: positive; see :obj:`woo.dem.Wall`)
See :obj:`woo.utils.sphere`'s documentation for meaning of other parameters."""
p=Particle()
p.shape=Wall(sense=sense,axis=axis,color=color if color else random.random())
if glAB: p.shape.glAB=glAB
if not fixed and mass<=0: raise ValueError("Non-fixed wall must have positive mass")
if isinstance(position,(int,long,float)):
pos2=Vector3(0,0,0); pos2[axis]=position
node=_mkDemNode(pos=pos2)
elif isinstance(position,Node): node=position
else: node=_mkDemNode(pos=position)
_commonBodySetup(p,[node],mat=mat,fixed=fixed)
p.shape.nodes[0].dem.mass=mass
p.aspherical=False # wall never rotates anyway
p.mask=mask
p.shape.visible=visible
return p
def wallBox(box,which=(1,1,1,1,1,1),**kw):
'''Return box delimited by walls, created by :obj:`woo.dem.Wall.make`, which receives most arguments. *which* determines which walls are created, in the order -x, +x, -y, +y, -z, +z.'''
ret=[]
if len(which)!=6: raise ValueError("Wall.makeBox: which must be a sequence of boolean-convertible.")
for sense,ix,coord in [(1,0,box.min),(-1,1,box.max)]:
for ax in (0,1,2):
if not which[3*ix+ax]: continue
ax1,ax2=(ax+1)%3,(ax+2)%3
ret.append(woo.dem.Wall.make(coord[ax],sense=sense,axis=ax,glAB=AlignedBox2((box.min[ax1],box.min[ax2]),(box.max[ax1],box.max[ax2])),**kw))
return ret
def rod(vertices,radius,fixed=True,wire=True,color=None,mat=defaultMaterial,visible=True,mask=DemField.defaultBoundaryMask,__class=woo.dem.Rod):
'''Create :obj:`~woo.dem.Rod` with given parameters:
:param vertices: endpoints given as coordinates (Vector3) or nodes
:param radius: radius of the rod
:param wire: render as wire by default
:param color: color as scalar (0...1); if not given, random color is assigned
:param mat: material; if not given, default material is assigned
:param visible:
:param mask:
'''
assert len(vertices)==2
nodes=[]
for i in (0,1):
if isinstance(vertices[i],Node): nodes.append(vertices[i])
else: nodes.append(_mkDemNode(pos=vertices[i]))
if not nodes[-1].dem: nodes[-1].dem=DemData()
p=Particle()
p.shape=__class(radius=radius,color=color if color else random.random())
p.shape.wire=wire
_commonBodySetup(p,nodes,mat=mat,fixed=fixed)
p.mask=mask
p.shape.visible=visible
return p
def truss(*args,**kw):
return rod(__class=woo.dem.Truss,*args,**kw)
def facet(vertices,fakeVel=None,halfThick=0.,fixed=True,wire=True,color=None,highlight=False,mat=defaultMaterial,visible=True,mask=DemField.defaultBoundaryMask,flex=None,__class=woo.dem.Facet):
"""Create facet with given parameters.
:param [Vector3,Vector3,Vector3] vertices: coordinates of vertices in the global coordinate system.
:param bool wire: if ``True``, facets are shown as skeleton; otherwise facets are filled
See :obj:`woo.utils.sphere`'s documentation for meaning of other parameters."""
p=Particle()
nodes=[]
if isinstance(vertices[0],Node):
nodes=vertices
for n in nodes:
if not n.dem: n.dem=DemData()
else:
nodes=[_mkDemNode(pos=vertices[0]),_mkDemNode(pos=vertices[1]),_mkDemNode(pos=vertices[2])]
if flex!=None:
if flex:
warnings.warn('Facet.make(...,flex=True) is deprecated, use Membrane.make(...) instead.',DeprecationWarning,stacklevel=2)
__class=woo.fem.Membrane
p.shape=__class(color=color if color else random.random(),halfThick=halfThick)
if fakeVel: p.shape.fakeVel=fakeVel
p.shape.wire=wire
_commonBodySetup(p,nodes,mat=mat,fixed=fixed)
p.aspherical=False # mass and inertia are 0 anyway; fell free to change to ``True`` if needed
p.mask=mask
p.shape.visible=visible
return p
def membrane(*args,**kw):
if 'flex' in kw: raise ValueError("Membrane.make: *flex* argument not accepted (use Membrane.make for Membranes and Facet.make for pure facets).")
return facet(__class=woo.fem.Membrane,*args,**kw)
def tetra(vertices,fixed=True,wire=True,color=None,highlight=False,mat=defaultMaterial,visible=True,mask=DemField.defaultBoundaryMask,__class=woo.fem.Tetra):
'''Create tetrahedral particle'''
p=Particle()
nodes=[]
for i in range(4):
if isinstance(vertices[i],Node):
nodes.append(vertices[i])
if not nodes[-1].dem: nodes[-1].dem=DemData()
else: nodes.append(_mkDemNode(pos=vertices[i]))
p.shape=__class(color=color if color else random.random())
assert len(nodes)==4
_commonBodySetup(p,nodes,mat=mat,fixed=fixed)
p.aspherical=False
p.mask=mask
p.shape.wire=wire
p.shape.visible=visible
p.shape.canonicalizeVertexOrder()
return p
def tet4(*args,**kw):
return tetra(__class=woo.fem.Tet4,*args,**kw)
def infCylinder(position,radius,axis,glAB=None,fixed=True,mass=0,color=None,wire=False,mat=defaultMaterial,mask=DemField.defaultMovableMask):
"""Return a ready-made infinite cylinder particle."""
p=Particle()
p.shape=InfCylinder(radius=radius,axis=axis,color=color if color else random.random())
if glAB: p.shape.glAB=glAB
p.shape.wire=wire
node=position if isinstance(position,Node) else _mkDemNode(pos=position)
_commonBodySetup(p,[node],mat=mat,fixed=fixed)
p.aspherical=False # only rotates along one axis
p.mask=mask
return p
def importNmesh(filename,mat,mask,trsf=None,dem=None,surf=True,surfMat=None,surfMask=None,surfHalfThick=0.):
'''
Import nmesh file, text format written by `Netgen <http://sourceforge.net/projects/netgen-mesher/>`__. All nodes are created with :obj:`woo.dem.DemData.blocked` equal to ``XYZ`` (no rotations, but all translations allowed); if some of them are to be fixed, this must be done by the user after calling the function. Tetrahedra mass is lumped onto nodes. Thickness of surface triangles (if any) is ignored for mass lumping.
:param mat: material for volume (:obj:`woo.fem.Tet4`) elements.
:param mask: :obj:`woo.dem.Particle.mask` for new volume elements.
:param trsf: callable for transforming input-file vertex coordinate to the simulation space.
:param dem: a :obj:`woo.dem.DemField` instance; if given, nodes and particles will be added to this :obj:`~woo.dem.DemField`.
:param surf: create surface triangulation, for collisions.
:param surfMat: material for surface (:obj:`woo.dem.Facet`); if ``None``, *mat* is used.
:param surfMask: mask for surface; if ``None``, *mask* is used.
:param surfHalfThick: :obj:`woo.dem.Facet.halfThick` for the surface (must be positive for collisions between two triangulated surfaces).
:return: ([Node,Node,...],[Particle,Particle,...])
'''
with open(filename) as m:
mesh=[]
lens=[]
for ll in m:
l=ll[:-1].split()
if len(l)==1:
mesh.append([])
lens.append(int(l[0])) # for consistency check below
elif len(mesh)==1:
v=Vector3(tuple([float(i) for i in l]))
if trsf: v=trsf(v)
mesh[-1].append(v)
else: mesh[-1].append(tuple([int(i)-1 for i in l[1:]]))
for i,name in [(0,'nodes'),(1,'triangles'),(2,'tetrahedra')]:
if lens[i]!=len(mesh[i]): raise RuntimeError('Inconsistent nmesh file %s: number of %s should be %d, is %d.'%(filename,name,lens[i]),len(mesh[i]))
if len(mesh)!=3: raise RuntimeError('Error in %s: incorrect number of section (%d, should be 3)'%(filename, len(mesh)))
if surfMat==None: surfMat=mat
if surfMask==None: surfMask=mask
nn=[Node(pos=p,dem=DemData(blocked='XYZ')) for p in mesh[0]]
t4=[Tet4.make((nn[t[0]],nn[t[1]],nn[t[2]],nn[t[3]]),mat=mat,wire=True,fixed=None,mask=mask) for t in mesh[1]]
if surf: f3=[Facet.make((nn[t[0]],nn[t[1]],nn[t[2]]),mat=mat,wire=True,halfThick=surfHalfThick,fixed=None,mask=surfMask) for t in mesh[2]]
else: f3=[]
# lump mass
for n in nn:
n.dem.mass=sum([p.material.density*.25*p.shape.getVolume() for p in n.dem.parRef if isinstance(p.shape,Tet4)])
if dem:
dem.nodesAppend(nn)
dem.par.add(t4+f3)
return nn,t4+f3
if 0:
def aabbWalls(extrema=None,thickness=None,oversizeFactor=1.5,**kw):
"""Return 6 boxes that will wrap existing packing as walls from all sides;
extrema are extremal points of the Aabb of the packing (will be calculated if not specified)
thickness is wall thickness (will be 1/10 of the X-dimension if not specified)
Walls will be enlarged in their plane by oversizeFactor.
returns list of 6 wall Bodies enclosing the packing, in the order minX,maxX,minY,maxY,minZ,maxZ.
"""
walls=[]
if not extrema: extrema=aabbExtrema()
if not thickness: thickness=(extrema[1][0]-extrema[0][0])/10.
for axis in [0,1,2]:
mi,ma=extrema
center=[(mi[i]+ma[i])/2. for i in range(3)]
extents=[.5*oversizeFactor*(ma[i]-mi[i]) for i in range(3)]
extents[axis]=thickness/2.
for j in [0,1]:
center[axis]=extrema[j][axis]+(j-.5)*thickness
walls.append(box(center=center,extents=extents,fixed=True,**kw))
walls[-1].shape.wire=True
return walls
def aabbDim(cutoff=0.,centers=False):
"""Return dimensions of the axis-aligned bounding box, optionally with relative part *cutoff* cut away."""
a=aabbExtrema(cutoff,centers)
return (a[1][0]-a[0][0],a[1][1]-a[0][1],a[1][2]-a[0][2])
def aabbExtrema2d(pts):
"""Return 2d bounding box for a sequence of 2-tuples."""
inf=float('inf')
min,max=[inf,inf],[-inf,-inf]
for pt in pts:
if pt[0]<min[0]: min[0]=pt[0]
elif pt[0]>max[0]: max[0]=pt[0]
if pt[1]<min[1]: min[1]=pt[1]
elif pt[1]>max[1]: max[1]=pt[1]
return tuple(min),tuple(max)
def perpendicularArea(axis):
"""Return area perpendicular to given axis (0=x,1=y,2=z) generated by bodies
for which the function consider returns True (defaults to returning True always)
and which is of the type :obj:`woo.dem.Sphere`.
"""
ext=aabbExtrema()
other=((axis+1)%3,(axis+2)%3)
return (ext[1][other[0]]-ext[0][other[0]])*(ext[1][other[1]]-ext[0][other[1]])
def fractionalBox(fraction=1.,minMax=None):
"""retrurn (min,max) that is the original minMax box (or aabb of the whole simulation if not specified)
linearly scaled around its center to the fraction factor"""
if not minMax: minMax=aabbExtrema()
half=[.5*(minMax[1][i]-minMax[0][i]) for i in [0,1,2]]
return (tuple([minMax[0][i]+(1-fraction)*half[i] for i in [0,1,2]]),tuple([minMax[1][i]-(1-fraction)*half[i] for i in [0,1,2]]))
def randomizeColors(onlyDynamic=False):
"""Assign random colors to :obj:`woo.dem.Shape.color`.
If onlyDynamic is true, only dynamic bodies will have the color changed.
"""
for b in O.bodies:
color=(random.random(),random.random(),random.random())
if b.dynamic or not onlyDynamic: b.shape.color=color
if 0:
def avgNumInteractions(cutoff=0.,skipFree=False):
r"""Return average numer of interactions per particle, also known as *coordination number* $Z$. This number is defined as
.. math:: Z=2C/N
where $C$ is number of contacts and $N$ is number of particles.
With *skipFree*, particles not contributing to stable state of the packing are skipped, following equation (8) given in [Thornton2000]_:
.. math:: Z_m=\frac{2C-N_1}{N-N_0-N_1}
:param cutoff: cut some relative part of the sample's bounding box away.
:param skipFree: see above.
"""
if cutoff==0 and not skipFree: return 2*O.interactions.countReal()*1./len(O.bodies)
else:
nums,counts=bodyNumInteractionsHistogram(aabbExtrema(cutoff))
## CC is 2*C
CC=sum([nums[i]*counts[i] for i in range(len(nums))]); N=sum(counts)
if not skipFree: return CC*1./N
## find bins with 0 and 1 spheres
N0=0 if (0 not in nums) else counts[nums.index(0)]
N1=0 if (1 not in nums) else counts[nums.index(1)]
NN=N-N0-N1
return (CC-N1)*1./NN if NN>0 else float('nan')
def plotNumInteractionsHistogram(cutoff=0.):
"Plot histogram with number of interactions per body, optionally cutting away *cutoff* relative axis-aligned box from specimen margin."
nums,counts=bodyNumInteractionsHistogram(aabbExtrema(cutoff))
import pylab
pylab.bar(nums,counts)
pylab.title('Number of interactions histogram, average %g (cutoff=%g)'%(avgNumInteractions(cutoff),cutoff))
pylab.xlabel('Number of interactions')
pylab.ylabel('Body count')
pylab.show()
def plotDirections(aabb=(),mask=0,bins=20,numHist=True,noShow=False):
"""Plot 3 histograms for distribution of interaction directions, in yz,xz and xy planes and
(optional but default) histogram of number of interactions per body.
:returns: If *noShow* is ``False``, displays the figure and returns nothing. If *noShow*, the figure object is returned without being displayed (works the same way as :obj:`woo.plot.plot`).
"""
import pylab,math
from woo import utils
for axis in [0,1,2]:
d=utils.interactionAnglesHistogram(axis,mask=mask,bins=bins,aabb=aabb)
fc=[0,0,0]; fc[axis]=1.
subp=pylab.subplot(220+axis+1,polar=True);
# 1.1 makes small gaps between values (but the column is a bit decentered)
pylab.bar(d[0],d[1],width=math.pi/(1.1*bins),fc=fc,alpha=.7,label=['yz','xz','xy'][axis])
#pylab.title(['yz','xz','xy'][axis]+' plane')
pylab.text(.5,.25,['yz','xz','xy'][axis],horizontalalignment='center',verticalalignment='center',transform=subp.transAxes,fontsize='xx-large')
if numHist:
pylab.subplot(224,polar=False)
nums,counts=utils.bodyNumInteractionsHistogram(aabb if len(aabb)>0 else utils.aabbExtrema())
avg=sum([nums[i]*counts[i] for i in range(len(nums))])/(1.*sum(counts))
pylab.bar(nums,counts,fc=[1,1,0],alpha=.7,align='center')
pylab.xlabel('Interactions per body (avg. %g)'%avg)
pylab.axvline(x=avg,linewidth=3,color='r')
pylab.ylabel('Body count')
if noShow: return pylab.gcf()
else: pylab.show()
def makeVideo(frameSpec,out,renameNotOverwrite=True,fps=24,kbps=15000,holdLast=-.5):
"""Create a video from external image files using `mencoder <http://www.mplayerhq.hu>`__, `avconv <http://libav.org/avconv.html>`__ or `ffmpeg <http://www.ffmpeg.org>`__ (whichever is found on the system). Encodes using the default mencoder codec (mpeg4), two-pass with mencoder and one-pass with avconv, running multi-threaded with number of threads equal to number of OpenMP threads allocated for Woo.
:param frameSpec: wildcard | sequence of filenames. If list or tuple, filenames to be encoded in given order; otherwise wildcard understood by mencoder's mf:// URI option (shell wildcards such as ``/tmp/snap-*.png`` or and printf-style pattern like ``/tmp/snap-%05d.png``), if using mencoder, or understood by ``avconv`` or ``ffmpeg`` if those are being used.
:param str out: file to save video into
:param bool renameNotOverwrite: if True, existing same-named video file will have -*number* appended; will be overwritten otherwise.
:param int fps: Frames per second (``-mf fps=…``)
:param int kbps: Bitrate (``-lavcopts vbitrate=…``) in kb/s
:param holdLast: Repeat the last frame this many times; if negative, it means seconds and will be converted to frames according to *fps*. This option is not applicable if *frameSpec* is a wildcard (as opposed to a list of images).
.. note:: ``avconv`` and ``ffmpeg`` need symlinks, which are not available under Windows.
"""
# find which encoder to actually use
import distutils.spawn
menc=distutils.spawn.find_executable('mencoder')
ffmp=distutils.spawn.find_executable('ffmpeg')
avco=distutils.spawn.find_executable('avconv')
# the first one wins
if False and menc: encExec,encType=menc,'mencoder'
elif avco: encExec,encType=avco,'avconv'
elif ffmp: encExec,encType=ffmp,'avconv'
else: raise RuntimeError('No suitable video encoder (mencoder, ffmpeg, avconv) found in PATH.')
import os,os.path,subprocess
if renameNotOverwrite and os.path.exists(out):
i=0
while(os.path.exists(out+"~%d"%i)): i+=1
os.rename(out,out+"~%d"%i); print "Output file `%s' already existed, old file renamed to `%s'"%(out,out+"~%d"%i)
if holdLast<0: holdLast*=-fps
if isinstance(frameSpec,list) or isinstance(frameSpec,tuple):
if holdLast>0: frameSpec=list(frameSpec)+int(holdLast)*[frameSpec[-1]]
frameSpecMenc=','.join(frameSpec)
frameSpecAvconv=list(frameSpec)
else:
frameSpecMenc=frameSpec
frameSpecAvconv=[frameSpec]
if encType=='avconv': raise RuntimeError('Encoding via ffmpeg/avconv is only possible when list of files (as opposed to a pattern) is passed.')
if encType=='avconv':
if sys.platform=='win32': raise RuntimeError('Encoding via ffmpeg/avconv is not yet implemented under Windows (symlinks not functional on this platform).')
symDir=woo.master.tmpFilename()
os.mkdir(symDir)
ff2=[]
ext=os.path.splitext(frameSpecAvconv[0])[1]
symPattern=symDir+'/%05d'+ext
for i,f in enumerate(frameSpecAvconv):
ff2.append(symPattern%i)
os.symlink(f,ff2[-1])
frameSpecAvconv=ff2
# write input images to file
#if encType=='avconv':
# i=woo.master.tmpFilename()+'.txt'
# with open(i,'w') as ii:
# for f in frameSpecAvconv: ii.write("file '%s'\n"%f)
# frameSpecAvconv=[i]
devNull='nul' if (sys.platform=='win32') else '/dev/null'
# mencoder normally creates divx2pass.log in the current dir, which might fail
# use temp file instead, explicitly
passLogFile=woo.master.tmpFilename()+'.log'
# passNo==0 means single pass (avconv)
for passNo in ((1,2) if encType=='mencoder' else (0,)):
if encType=='mencoder': cmd=[encExec,'mf://%s'%frameSpecMenc,'-mf','fps=%d'%int(fps),'-ovc','lavc','-lavcopts','vbitrate=%d:vpass=%d:threads=%d:%s'%(int(kbps),passNo,woo.master.numThreads,'turbo' if passNo==1 else ''),'-passlogfile',passLogFile,'-o',(devNull if passNo==1 else out)]
elif encType=='avconv':
#inputs=sum([['-i',f] for f in frameSpecAvconv],[])
# inputs=['-i','concat:"'+'|'.join(frameSpecAvconv)+'"']
inputs=['-i',symPattern]
cmd=[encExec]+inputs+['-r',str(int(fps)),'-b:v','%dk'%int(kbps),'-threads',str(woo.master.numThreads)]+(['-pass',str(passNo),'-passlogfile',passLogFile] if passNo>0 else [])+['-an']+(['-f','rawvideo','-y',devNull] if passNo==1 else ['-f','mp4','-y',out])
print 'Pass %d:'%passNo,' '.join(cmd)
ret=subprocess.call(cmd)
if ret!=0: raise RuntimeError("Error running %s."%encExec)
# clean up symlinks directory
if encType=='avconv':
import shutil
shutil.rmtree(symDir)
def _procStatus(name):
import os
for l in open('/proc/%d/status'%os.getpid()):
if l.split(':')[0]==name: return l
raise "No such line in /proc/[pid]/status: "+name
def vmData():
"Return memory usage data from Linux's /proc/[pid]/status, line VmData."
l=_procStatus('VmData'); ll=l.split(); assert(ll[2]=='kB')
return int(ll[1])
if 0:
def trackPerfomance(updateTime=5):
"""
Track perfomance of a simulation. (Experimental)
Will create new thread to produce some plots.
Useful for track perfomance of long run simulations (in bath mode for example).
"""
def __track_perfomance(updateTime):
pid=os.getpid()
threadsCpu={}
lastTime,lastIter=-1,-1
while 1:
time.sleep(updateTime)
if not O.running:
lastTime,lastIter=-1,-1
continue
if lastTime==-1:
lastTime=time.time();lastIter=O.iter
plot.plots.update({'Iteration':('Perfomance',None,'Bodies','Interactions')})
continue
curTime=time.time();curIter=O.iter
perf=(curIter-lastIter)/(curTime-lastTime)
out=subprocess.Popen(['top','-bH','-n1', ''.join(['-p',str(pid)])],stdout=subprocess.PIPE).communicate()[0].splitlines()
for s in out[7:-1]:
w=s.split()
threadsCpu[w[0]]=float(w[8])
plot.addData(Iteration=curIter,Iter=curIter,Perfomance=perf,Bodies=len(O.bodies),Interactions=len(O.interactions),**threadsCpu)
plot.plots.update({'Iter':threadsCpu.keys()})
lastTime=time.time();lastIter=O.iter
thread.start_new_thread(__track_perfomance,(updateTime))
if sys.platform=='win32':
def fixWindowsPath(p):
'''On Windows, replace some well-known UNIX directories by their native equivalents,
so that defaults works cross-platform. Currently, the following substitutions are made:
1. leading `/tmp` is transformed to `%TEMP%` (or c:/temp is undefined)
'''
if p=='/tmp' or p.startswith('/tmp/'):
temp=os.environ.get('TEMP','c:/temp')
return temp+p[4:]
return p
else:
def fixWindowsPath(p): return p
def xMirror(half):
"""Mirror a sequence of 2d points around the x axis (changing sign on the y coord).
The sequence should start up and then it will wrap from y downwards (or vice versa).
If the last point's x coord is zero, it will not be duplicated."""
return list(half)+[(x,-y) for x,y in reversed(half[:-1] if half[-1][0]==0 else half)]
def tesselatePolyline(l,maxDist):
'''Return polyline tesselated so that distance between consecutive points is no more than maxDist. *l* is list of points (Vector2 or Vector3).'''
ret=[]
for i in range(len(l)-1):
x0,x1=l[i],l[i+1]
dX=x1-x0
dist=dX.norm()
if dist>maxDist:
nDiv=int(dist/maxDist+(1 if int(dist/maxDist)*maxDist<dist else 0))
for j in range(int(nDiv)): ret.append(x0+dX*(j*1./nDiv))
else: ret.append(x0)
ret.append(l[-1])
return ret
def htmlReportHead(S,headline,dialect='xhtml',repBase=''):
'''
Return (X)HTML fragment for simulation report: (X)HTML header, title, Woo logo, configuration and preprocessor parameters.
In order to obtain a well-formed XHTML document, don't forget to add '</body></html>'.
'''
import time, platform, pkg_resources, shutil
if py3k: import base64
headers=dict(xhtml='''<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xmlns:svg="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">\n''',html5='<!DOCTYPE html><html lang="en">',html4='<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"><html>')
logoSrc=pkg_resources.resource_filename('woo','data/woo-icon.128.png')
logoExtern='%s_wooLogo.png'%(repBase)
logoBase64='<img src="data:image/png;base64,'+(str(base64.b64encode(open(logoSrc,'rb').read())) if py3k else open(logoSrc).read().encode('base64'))+'" alt="Woo logo"/>'
logoImgExtern='<img src="%s_wooLogo.png" alt="Woo logo"/>'%(repBase)
svgLogos=dict(
# embedded svg
xhtml=svgFileFragment(pkg_resources.resource_filename('woo','data/woodem-6.woo.svg')),
# embedded base64-encoded pngs
html5=logoBase64,
html4=logoImgExtern,
)
if dialect not in headers: raise ValueError("Unsupported HTML dialect '%s'; must be one of: "+', '.join(headers.keys()))
if dialect=='html4': shutil.copyfile(logoSrc,logoExtern)
# <meta http-equiv="content-type" content="text/html;charset=UTF-8" />
html=(u'''<head><title>{headline}</title><meta charset="utf-8"/></head><body>
<h1>{headline}</h1>
<h2>General</h2>
<table style="text-align: center">
<tr><td rowspan="3">{svgLogo}</td><td><a href="http://www.woodem.eu/">Woo[dem]</a></td></tr>
<tr><td>© <a href="mailto:vaclav.smilauer@woodem.eu">Václav Šmilauer</a></td></tr>
<tr><td>Licensed under <a href="http://opensource.org/licenses/gpl-2.0.php">GNU GPL v2</a></td></tr>
</table>
<table>
<tr><td>title</td><td align="right">{title}</td></tr>
<tr><td>id</td><td align="right">{id}</td></tr>
<tr><td>started</td><td align="right">{started}</td></tr>
<tr><td>duration</td><td align="right">{duration:g} s ({step} steps)</td></tr>
<tr><td>average speed</td><td align="right">{stepsPerSec:g} steps/sec</td></tr>
<tr><td>operator</td><td align="right">{user}</td></tr>
<tr><td>number of cores used</td><td align="right">{nCores}</td></tr>
<tr><td>engine</td><td align="right">{engine}</td></tr>
<tr><td>compiled with</td><td align="right">{compiledWith}</td></tr>
<tr><td>platform</td><td align="right">{platform}</td></tr>
</table>
'''.format(headline=headline,title=(S.tags['title'] if S.tags['title'] else '<i>[none]</i>'),id=S.tags['id'],user=(S.tags['user'] if py3k else S.tags['user'].decode('utf-8')),started=time.ctime(time.time()-woo.master.realtime),step=S.step,duration=woo.master.realtime,nCores=woo.master.numThreads,stepsPerSec=S.step/woo.master.realtime,engine='wooDem '+woo.config.version+'/'+woo.config.revision+(' (debug)' if woo.config.debug else ''),compiledWith=','.join(woo.config.features),platform=platform.platform().replace('-',' '),svgLogo=svgLogos[dialect])
+'<h2>Input data</h2>'+S.pre.dumps(format='html',fragment=True,showDoc=False)
)
return headers[dialect]+html
def htmlReport(S,repFmt,headline,afterHead='',figures=[],dialect=None,figFmt=None,svgEmbed=False,show=False):
'''
Generate (X)HTML report for simulation.
:param S: :obj:`Scene` object; must contain :obj:`Scene.pre`
:param repFmt: format for the output file; will be expanded using :obj:`Scene.tags`; it should end with `.html` or `.xhtml`.
:param headline: title of the report, used as HTML title and the first ``<h1>`` heading.
:param afterHead: contents (XHTML fragment) to be added verbatim after the header (title, woo config table, preprocessor parameters)
:param figs: figures included in the report; they are either embedded (SVG, optionally ) or saved to files in the same directory as the report, using its name as prefix, and referenced via relative links from the XHTML. Figures are given as list of 2- or 3-tuples, where each item contains:
1. name of the figure (will generate a ``<h2>`` heading)
2. figure object (`Matplotlib <http://matplotlib.org>`__ figure object)
3. optionally, format to save the figure to (`svg`, `png`, ...)
:param figFmt: format of figures, if the format is not specified by the figure itself; if None, choose format appropriate for given dialect (png for html4, svg for html5 and xhtml)
:param dialect: one of "xhtml", "html5", "html4"; if not given (*None*), selected from file suffix (``.html`` for ``html4``, ``.xhtml`` for ``xhtml``). ``html4`` will save figures as PNG (even if something else is specified) so that the resulting file is easily importable into LibreOffice (which does not import HTML with SVG correctly now).
:param svgEmbed: don't save SVG as separate files, embed them in the report instead.
:param show: open the report in browser via the webbrowser module, unless running in batch.
:return: (filename of the report, list of external figures)
'''
import codecs, re, os.path
import woo,woo.batch
dialects=set(['html5','html4','xhtml'])
if not dialect:
if repFmt.endswith('.xhtml'): dialect='xhtml'
elif repFmt.endswith('.html'): dialect='html4'
else: raise ValueError("Unable to guess dialect (not given) from *repFmt* '%s' (not ending in .xhtml or .html)")
if dialect not in dialects: raise ValueError("Unknown dialect '%s': must be one of "+', '.join(dialects)+'.')
if figFmt==None: figFmt={'html5':'png','html4':'png','xhtml':'svg'}[dialect]
if dialect in ('html5',) and svgEmbed and figFmt=='svg':
svgEmbed=False
warnings.warn("Dialect '%s' does not support embedded SVG -- will not be embedded."%dialect)
if dialect in ('html4',) and not figFmt=='png':
warnings.warn("Dialect '%s' will save images as 'png', not '%s'"%(dialect,figFmt))
figFmt='png'
repName=unicode(repFmt).format(S=S,**(dict(S.tags)))
rep=codecs.open(repName,'w','utf-8','replace')
print 'Writing report to file://'+os.path.abspath(repName)
repBase=re.sub('\.x?html$','',repName)
s=htmlReportHead(S,headline,dialect=dialect,repBase=repBase)
s+=afterHead
if figures: s+='<h2>Figures</h2>\n'
extFiles=[]
from matplotlib.backends.backend_agg import FigureCanvasAgg
for ith,figspec in enumerate(figures):
if len(figspec)==2: figspec=(figspec[0],figspec[1],figFmt)
figName,figObj,figSuffix=figspec
if not figName: figName='Figure %i'%(ith+1)
s+='<h3>'+figName+'</h3>'
canvas=FigureCanvasAgg(figObj)
if figSuffix=='svg' and svgEmbed:
figFile=woo.master.tmpFilename()+'.'+figSuffix
figObj.savefig(figFile)
s+=svgFileFragment(figFile)
else:
figFile=repBase+'.'+re.sub('[^a-zA-Z0-9_-]','_',figName)+'.'+figSuffix
figObj.savefig(figFile)
s+='<img src="%s" alt="%s"/>'%(os.path.basename(figFile),figName)
extFiles.append(os.path.abspath(figFile))
s+='</body></html>'
rep.write(s)
rep.close() # flushed write buffers
# attempt conversion to ODT, not under Windows
if False and sys.platform!='win32':
# TODO TODO TODO: have timeout on the abiword call; some versions stall forever
def convertToOdt(html,odt):
try:
import subprocess
# may raise OSError if the executable is not found
out=subprocess.check_output(['abiword','--to=ODT','--to-name='+odt,html])
print 'Report converted to ODT via Abiword: file://'+os.path.abspath(odt)
except subprocess.CalledProcessError as e:
print 'Report conversion to ODT failed (error when running Abiword), returning %d; the output was: %s.'%(e.returncode,e.output)
except:
print 'Report conversion to ODT not done (Abiword not installed?).'
# if this is run in the background, main process may finish before that thread, leading potentially to some error messages??
import threading
threading.Thread(target=convertToOdt,args=(repName,repBase+'.odt')).start()
if show and not woo.batch.inBatch():
import webbrowser
webbrowser.open('file://'+os.path.abspath(repName))
return repName,extFiles
def svgFileFragment(filename):
'Return fragment beginning with ``<svg`` till the end of given *filename*. Those data may be used for embedding SVG in other formats, such as XHTML.'
import codecs,re
data=codecs.open(filename,encoding='utf-8').read()
# returns the first match
for m in re.finditer(r'<svg( |$)',data,flags=re.MULTILINE): return data[m.start():]
raise RuntimeError('"<svg" was not found in %s'%filename)
def ensureWriteableDir(d):
'Make sure given directory is writeable; raise exception (IOError) if not.'
import errno, os
try:
os.makedirs(d)
print 'Created directory:',d
except OSError as e:
if e.errno!=errno.EEXISTS:
print 'ERROR: failed to create directory '+d
raise
if not os.access(d,os.W_OK): raise IOError('Directory %s not writeable.'%d)
def runAllPreprocessors():
'Run all preprocessors with default parameters, and run the very first step of their simulation.'
for P in woo.system.childClasses(woo.core.Preprocessor):
print 50*'#'+'\n'+10*' '+P.__module__+'.'+P.__name__+'\n'+50*'#'
S=woo.master.scene=P()()
S.one
print 20*'*'+' ALL OK '+20*'*'
def unbalancedEnergy(S):
if not S.trackEnergy: raise RuntimeError('Scene.trackEnergy==False')
if not 'elast' in S.energy or 'kinetic' not in S.energy: return float('nan')
#raise RuntimeError('Scene.energy: does not contain *elast* or *kinetic* keys')
# this line seems to be necessary under Windows, zero raises ZeroDivisionError...?!
if S.energy['elast']==0: return float('nan')
return S.energy['kinetic']/S.energy['elast']
#############################
##### deprecated functions
def _deprecatedUtilsFunction(old,new):
"Wrapper for deprecated functions, example below."
warnings.warn('Function utils.%s is deprecated, use %s instead.'%(old,new),stacklevel=2,category=DeprecationWarning)
# example of _deprecatedUtilsFunction usage:
#
# def import_mesh_geometry(*args,**kw):
# "|ydeprecated|"
# _deprecatedUtilsFunction('import_mesh_geometry','woo.import.gmsh')
# import woo.ymport
# return woo.ymport.stl(*args,**kw)
import woo.batch
def runningInBatch():
_deprecatedUtilsFunction('runningInBatch','woo.batch.inBatch')
return woo.batch.inBatch()
def waitIfBatch():
_deprecatedUtilsFunction('waitIfBatch','woo.batch.wait')
return woo.batch.wait()
def readParamsFromTable(*args,**kw):
_deprecatedUtilsFunction('readParamsFromTable','woo.batch.readParamsFromTable')
return woo.batch.readParamsFromTable(*args,**kw)
def runPreprocessorInBatch(*args,**kw):
_deprecatedUtilsFunction('runPreprocessorInBatch','woo.batch.runPreprocessor')
return woo.batch.runPreprocessor(*args,**kw)
|