parameters: (radius=1, height=1, nSegments=8,
                     pos=None, rot=None, boundaryMarker=0, **kwargs)
return_statement: return poly
docstring: Create PLC of a cylinder.
  
      Out of core wrapper for dcfemlib::polytools.
  
      Note, there is a bug in the old polytools which ignores the area settings
      for marker == 0.
  
      Parameters
      ----------
      radius : float
          Radius of the cylinder.
  
      height : float
          Height of the cylinder
  
      nSegments : int [8]
          Number of segments of the cylinder.
  
      pos : pg.Pos [None]
          The center position, default is at the origin.
  
      Keyword Arguments
      ----------------
      ** kwargs:
          Marker related arguments:
          See :py:mod:`pygimli.meshtools.polytools.setPolyRegionMarker`
  
      Returns
      -------
      poly : :gimliapi:`GIMLI::Mesh`
          The resulting polygon is a :gimliapi:`GIMLI::Mesh`.
docstring_summary: Create PLC of a cylinder.
docstring_tokens: Create PLC of a cylinder .
function: def createCylinder(radius=1, height=1, nSegments=8,
                     pos=None, rot=None, boundaryMarker=0, **kwargs):
      """Create PLC of a cylinder.
  
      Out of core wrapper for dcfemlib::polytools.
  
      Note, there is a bug in the old polytools which ignores the area settings
      for marker == 0.
  
      Parameters
      ----------
      radius : float
          Radius of the cylinder.
  
      height : float
          Height of the cylinder
  
      nSegments : int [8]
          Number of segments of the cylinder.
  
      pos : pg.Pos [None]
          The center position, default is at the origin.
  
      Keyword Arguments
      ----------------
      ** kwargs:
          Marker related arguments:
          See :py:mod:`pygimli.meshtools.polytools.setPolyRegionMarker`
  
      Returns
      -------
      poly : :gimliapi:`GIMLI::Mesh`
          The resulting polygon is a :gimliapi:`GIMLI::Mesh`.
  
      """
      circ = createCircle(radius=radius, nSegments=nSegments)
      poly = extrude(circ, z=height, boundaryMarker=boundaryMarker, **kwargs)
      # move it to z=0
      poly.translate([0.0, 0.0, -height/2])
  
      if rot is not None:
          c = pg.center(poly.positions())
          poly.translate(-c)
          poly.rotate(rot)
          poly.translate(c)
  
      if pos is not None:
          poly.translate(pos)
  
      return poly
function_tokens: def createCylinder ( radius = 1 , height = 1 , nSegments = 8 , pos = None , rot = None , boundaryMarker = 0 , * * kwargs ) : circ = createCircle ( radius = radius , nSegments = nSegments ) poly = extrude ( circ , z = height , boundaryMarker = boundaryMarker , * * kwargs ) # move it to z=0 poly . translate ( [ 0.0 , 0.0 , - height / 2 ] ) if rot is not None : c = pg . center ( poly . positions ( ) ) poly . translate ( - c ) poly . rotate ( rot ) poly . translate ( c ) if pos is not None : poly . translate ( pos ) return poly