PoreMS 0.3
  • API
  • Molecule
  • Pore
  • Workflow
  • Pore shape examples
  • Site
    • Page
        • Sphere
          • Sphere
    • Sphere
      • Sphere
    Source

    Sphere¶

    class porems.shape.Sphere(inp)¶

    This class defines a sphere shape. Needed inputs are

    • central - Central axis

    • centroid - Sphere Centroid

    • diameter - Sphere diameter

    Parameters:
    inpdictionary

    Dictionary of necessary inputs

    Methods

    Phi(r, theta, phi)

    Surface function of a sphere

    convert(data[, to_zero])

    This helper method rotates the given data to match the global central axis and translates it so that the center point is aligned.

    d_Phi_phi(r, theta, phi)

    Derivative of the surface function considering the polar angle \(\phi\)

    d_Phi_theta(r, theta, phi)

    Derivative of the surface function considering the azimuthal angle \(\theta\)

    get_inp()

    Return full input dictionary.

    is_in(pos)

    Check if given position is inside of shape.

    normal(pos)

    Calculate unit normal vector on surface for a given position

    plot([inp, num, vec])

    Plot surface and rim.

    rim(phi[, num])

    Return x and y values for given polar angle.

    surf([num])

    Return x, y and z values for the shape.

    surface()

    Calculate inner surface

    volume()

    Calculate volume

    Back to top

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