Generators
==========

Relevant module: ``edelweissfe.config.generators``

.. automodule:: edelweissfe.config.generators
   :members: __doc__

``boxgen`` - A 3D box mesh generator
------------------------------------

Relevant module ``edelweissfe.generators.boxgen``

.. automodule:: edelweissfe.generators.boxgen
    :members: __doc__

.. pprint:: edelweissfe.generators.boxgen.documentation
   :caption: Options:

.. literalinclude:: ../../../testfiles/BoxGen/test.inp
    :language: edelweiss
    :caption: Example: ``testfiles/BoxGen/test.inp``

``planerectquad`` - A 2D plane rectangular mesh generator
---------------------------------------------------------

Relevant module ``edelweissfe.generators.planerectquad``

.. automodule:: edelweissfe.generators.planerectquad
   :members: __doc__,

.. pprint:: edelweissfe.generators.planerectquad.documentation
   :caption: Options:

.. literalinclude:: ../../../testfiles/NodeForces/test.inp
    :language: edelweiss
    :caption: Example: ``testfiles/NodeForces/test.inp``

``pipegen`` - A 3D pipe mesh generator
--------------------------------------

Relevant module ``edelweissfe.generators.pipegen``

.. pprint:: edelweissfe.generators.boxgen.documentation
   :caption: Options:

.. literalinclude:: ../../../testfiles/PipeGen/test.inp
    :language: edelweiss
    :caption: Example: ``testfiles/PipeGen/test.inp``

``cubit`` - A cubit mesh generator
----------------------------------

Relevant module ``edelweissfe.generators.cubit``

.. automodule:: edelweissfe.generators.cubit
   :members: __doc__

.. pprint:: edelweissfe.generators.cubit.documentation
   :caption: Options:

.. literalinclude:: ../../../testfiles/CubitGen/test.inp
    :language: edelweiss
    :caption: Example: ``testfiles/CubitGen/test.inp``

``findclosestnode`` - Find the closest node
-------------------------------------------

Relevant module ``edelweissfe.generators.findclosestnode``

.. automodule:: edelweissfe.generators.findclosestnode
   :members: __doc__

.. pprint:: edelweissfe.generators.findclosestnode.documentation
   :caption: Options:


``executepythoncode`` - Script model generation using Python
------------------------------------------------------------

Relevant module ``edelweissfe.generators.executepythoncode``

.. automodule:: edelweissfe.generators.executepythoncode
    :members: __doc__

.. pprint:: edelweissfe.generators.executepythoncode.documentation
   :caption: Options:

.. literalinclude:: ../../../testfiles/PythonCodeModelGeneration/test.inp
    :language: edelweiss
    :caption: Example: ``testfiles/PythonCodeModelGeneration/test.inp``