diff options
| -rw-r--r-- | Docs/Doxyfile | 52 | ||||
| -rw-r--r-- | Docs/source/conf.py | 8 | ||||
| -rw-r--r-- | Docs/source/cpp_class.rst | 5 | ||||
| -rw-r--r-- | Docs/source/index.rst | 6 | ||||
| -rw-r--r-- | Docs/source/python_class.rst | 5 | ||||
| -rw-r--r-- | Python/pywarpx/WarpX.py | 3 | ||||
| -rw-r--r-- | Source/WarpX.H | 8 |
7 files changed, 35 insertions, 52 deletions
diff --git a/Docs/Doxyfile b/Docs/Doxyfile index 7adec1d0d..61cdabb22 100644 --- a/Docs/Doxyfile +++ b/Docs/Doxyfile @@ -32,7 +32,7 @@ DOXYFILE_ENCODING = UTF-8 # title of most generated pages and in a few other places. # The default value is: My Project. -PROJECT_NAME = "My Project" +PROJECT_NAME = "WarpX" # The PROJECT_NUMBER tag can be used to enter a project or revision number. This # could be handy for archiving the generated documentation or if some version @@ -435,7 +435,7 @@ LOOKUP_CACHE_SIZE = 0 # normally produced when WARNINGS is set to YES. # The default value is: NO. -EXTRACT_ALL = NO +EXTRACT_ALL = YES # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will # be included in the documentation. @@ -790,7 +790,7 @@ WARN_LOGFILE = # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = ../Source +INPUT = ../Source/ # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses @@ -820,45 +820,11 @@ FILE_PATTERNS = *.c \ *.cxx \ *.cpp \ *.c++ \ - *.java \ - *.ii \ - *.ixx \ - *.ipp \ - *.i++ \ - *.inl \ - *.idl \ - *.ddl \ - *.odl \ *.h \ - *.hh \ - *.hxx \ - *.hpp \ - *.h++ \ - *.cs \ - *.d \ - *.php \ - *.php4 \ - *.php5 \ - *.phtml \ - *.inc \ - *.m \ - *.markdown \ - *.md \ - *.mm \ - *.dox \ + *.H \ *.py \ - *.pyw \ *.f90 \ - *.f95 \ - *.f03 \ - *.f08 \ - *.f \ - *.for \ - *.tcl \ - *.vhd \ - *.vhdl \ - *.ucf \ - *.qsf + *.f # The RECURSIVE tag can be used to specify whether or not subdirectories should # be searched for input files as well. @@ -1111,7 +1077,7 @@ GENERATE_HTML = YES # The default directory is: html. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_OUTPUT = html +HTML_OUTPUT = doxyhtml # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each # generated HTML page (for example: .htm, .php, .asp). @@ -1647,7 +1613,7 @@ EXTRA_SEARCH_MAPPINGS = # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output. # The default value is: YES. -GENERATE_LATEX = YES +GENERATE_LATEX = NO # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of @@ -1927,7 +1893,7 @@ MAN_LINKS = NO # captures the structure of the code including all documentation. # The default value is: NO. -GENERATE_XML = NO +GENERATE_XML = YES # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of @@ -1935,7 +1901,7 @@ GENERATE_XML = NO # The default directory is: xml. # This tag requires that the tag GENERATE_XML is set to YES. -XML_OUTPUT = xml +XML_OUTPUT = doxyxml # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program # listings (including syntax highlighting and cross-referencing information) to diff --git a/Docs/source/conf.py b/Docs/source/conf.py index 3d667ea26..572e803e3 100644 --- a/Docs/source/conf.py +++ b/Docs/source/conf.py @@ -17,9 +17,9 @@ # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. # -# import os -# import sys -# sys.path.insert(0, os.path.abspath('.')) +import os +import sys +sys.path.insert(0, os.path.join( os.path.abspath(__file__), '../Python') ) # -- General configuration ------------------------------------------------ @@ -40,7 +40,7 @@ extensions = ['sphinx.ext.autodoc', # Path to the Doxygen output breathe_default_project = "WarpX" -breathe_projects = { "myproject": "/home/me/docproj/doxyxml/" } +breathe_projects = { "WarpX": "../doxyxml" } # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] diff --git a/Docs/source/cpp_class.rst b/Docs/source/cpp_class.rst new file mode 100644 index 000000000..9f482a60e --- /dev/null +++ b/Docs/source/cpp_class.rst @@ -0,0 +1,5 @@ +The WarpX C++ class +=================== + +.. doxygenclass:: WarpX + :members: diff --git a/Docs/source/index.rst b/Docs/source/index.rst index be924995f..15785bbb9 100644 --- a/Docs/source/index.rst +++ b/Docs/source/index.rst @@ -7,10 +7,12 @@ Welcome to WarpX's documentation! ================================= .. toctree:: - :maxdepth: 2 + :maxdepth: 1 :caption: Contents: - + cpp_class + python_class + theory Indices and tables ================== diff --git a/Docs/source/python_class.rst b/Docs/source/python_class.rst new file mode 100644 index 000000000..033e9793a --- /dev/null +++ b/Docs/source/python_class.rst @@ -0,0 +1,5 @@ +The WarpX Python class +====================== + +.. autoclass:: pywarpx.WarpX + :members: diff --git a/Python/pywarpx/WarpX.py b/Python/pywarpx/WarpX.py index 976d94c74..e9ec7cca4 100644 --- a/Python/pywarpx/WarpX.py +++ b/Python/pywarpx/WarpX.py @@ -2,6 +2,9 @@ from .Bucket import Bucket from . import warpxC class WarpX(Bucket): + """ + A Python wrapper for the WarpX C++ class + """ def init(self): self.warpx = warpxC.WarpX.GetInstance() diff --git a/Source/WarpX.H b/Source/WarpX.H index 522e76edc..20467018a 100644 --- a/Source/WarpX.H +++ b/Source/WarpX.H @@ -14,6 +14,8 @@ #include <ParticleContainer.H> +/*! A test class */ + class WarpX : public amrex::AmrCore { @@ -36,7 +38,7 @@ public: static void FillBoundary (amrex::MultiFab& mf, const amrex::Geometry& geom, const amrex::IntVect& nodalflag); - static void shiftMF(amrex::MultiFab& mf, const amrex::Geometry& geom, int num_shift, + static void shiftMF(amrex::MultiFab& mf, const amrex::Geometry& geom, int num_shift, int dir, const amrex::IntVect& nodalflag); static void GotoNextLine (std::istream& is); @@ -57,7 +59,7 @@ public: protected: //! Tagging cells for refinement - virtual void ErrorEst (int lev, amrex::TagBoxArray& tags, amrex::Real time, int /*ngrow*/) override + virtual void ErrorEst (int lev, amrex::TagBoxArray& tags, amrex::Real time, int /*ngrow*/) override { amrex::Abort("ErrorEst: To be implemented"); } //! Make a new level from scratch using provided BoxArray and @@ -70,7 +72,7 @@ protected: //! DistributionMapping and fill with interpolated coarse level //! data. Called by AmrCore::regrid. virtual void MakeNewLevelFromCoarse (int lev, amrex::Real time, const amrex::BoxArray& ba, - const amrex::DistributionMapping& dm) override + const amrex::DistributionMapping& dm) override { amrex::Abort("MakeNewLevelFromCoarse: To be implemented"); } //! Remake an existing level using provided BoxArray and |