PoreMS 0.2
  • API
  • Process
  • Molecule
  • Pore
  • Workflow
  • Site
    • Page
        • Cylinder

    Cylinder¶

    class porems.shape.Cylinder(inp)¶

    This class defines a cylindric shape. Needed inputs are

    • central - Central axis
    • centroid - Centroid of block
    • length - Cylinder length
    • diameter - Cylinder diameter
    Parameters:
    inp : dictionary

    Dictionary of necessary inputs

    Surface Function

    Phi(self, r, phi, z) Surface function of a cylinder
    d_Phi_phi(self, r, phi, z) Derivative of the surface function considering the polar angle
    d_Phi_z(self, r, phi, z) Derivative of the surface function considering the z-axis

    Shape

    rim(self, z[, num]) Return x and y values for given z-position.
    surf(self[, num]) Return x, y and z values for the shape.

    Properties

    is_in(self, pos) Check if given position is inside of shape.
    normal(self, pos) Calculate unit normal vector on surface for a given position
    surface(self) Calculate inner surface
    volume(self) Calculate volume

    Back to top

    © Copyright 2021, Hamzeh Kraus.
    Created using Sphinx 1.6.6.