crunchflow.input.inputfile
==========================

.. py:module:: crunchflow.input.inputfile

.. autoapi-nested-parse::

   A module for creating and saving CrunchFlow input files.

   ..
       !! processed by numpydoc !!


Classes
-------

.. toctree::
   :hidden:

   /autoapi/crunchflow/input/inputfile/InputFile

.. autoapisummary::

   crunchflow.input.inputfile.InputFile


Functions
---------

.. autoapisummary::

   crunchflow.input.inputfile.format_class_name


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

.. py:function:: format_class_name(name)

   
   Convert a class name to the appropriate format for writing a block
   keyword in an input file. If the name is in camel case, an underscore is
   inserted between words. The name is then converted to uppercase.


   :Parameters:

       **name** : str
           The name of the class to convert.



   :Returns:

       str
           The class name converted to uppercase with underscores between words.











   ..
       !! processed by numpydoc !!