spectre.geometry
================

.. py:module:: spectre.geometry




Module Contents
---------------

.. py:function:: get_interface_geometry(xin, test, volumes=None, zeta=0.0, thetas=None, sarr=None)

.. py:function:: get_coord_transform(geometry, Rac, Rbc, Zas, Zbs, im, in_, sarr, tarr, zarr, lvol)

   Return coordinate transformations: R, dR/ds, dR/dtheta, dR/dzeta
                   (and for toroidal geometry: Z, dZ/ds, dZ/dtheta, dZ/dzeta)
   Returns:
                   Rarr
                   Zarr

   Stell. nonsymmetric eqilibria not supported!


.. py:function:: get_coord_transform_helper(geometry, Rac, Rbc, Zas, Zbs, im, in_, sarr, tarr, zarr, lvol)

   Return coordinate transformations: R, dR/ds, dR/dtheta, dR/dzeta
                                   (and for toroidal geometry: Z, dZ/ds, dZ/dtheta, dZ/dzeta)
   Returns:
                                   Rarr
                                   Zarr


.. py:function:: get_coord_deriv(geometry, Rac, Rbc, Zas, Zbs, im, in_, sarr, tarr, zarr, lvol)

   Return coordinate transformations: R, dR/ds, dR/dtheta, dR/dzeta
                   (and for toroidal geometry: Z, dZ/ds, dZ/dtheta, dZ/dzeta)
   Returns:
                   Rarr
                   Zarr

   Stell. nonsymmetric eqilibria not supported!


.. py:function:: get_coord_deriv_helper(geometry, Rac, Rbc, Zas, Zbs, im, in_, sarr, tarr, zarr, lvol)

   Return coordinate transformations: R, dR/ds, dR/dtheta, dR/dzeta
                                   (and for toroidal geometry: Z, dZ/ds, dZ/dtheta, dZ/dzeta)
   Returns:
                                   Rarr
                                   Zarr


.. py:function:: get_jacobian(geometry, Rac, Rbc, Zas, Zbs, im, in_, sarr, tarr, zarr, lvol)

.. py:function:: get_jacobian_helper_v2(geometry, im, in_, Rac, Rbc, Zas, Zbs, sarr, tarr, zarr, lvol)

.. py:function:: get_rz_drzdxin(xin, test, thetas=None, zetas=None)

.. py:function:: sth_to_RZ(Rac, Rbc, Zas, Zbs, Ras, Rbs, Zac, Zbc, im, in_, s, theta, zeta, singular_vol)

   Convert (s, theta) of a point to its (R, Z) description.

   Returns:
       ndarray[float]: R, Z coordinates in an array of shape (2, len(s))


.. py:function:: at_volume_edge(phi, sth, Aze, Ate, Azo, Ato, im, in_, lrad, mpol)

   If s > 1.0 or s < -1.0, returns 0.0, else returns 1.0. For use in CyRK edge detection (argument layout by CyRK).

   Returns:
       float: Indicator if outside of the domain