From 9ec2fce9130806adec8bdc7d15dff3a969975cc1 Mon Sep 17 00:00:00 2001 From: Cristian C Lalescu <Cristian.Lalescu@ds.mpg.de> Date: Sun, 24 Jan 2016 09:51:57 +0100 Subject: [PATCH] add basic descriptions for classes --- bfps/FluidConvert.py | 5 +++++ bfps/FluidResize.py | 4 ++++ bfps/Launcher.py | 5 +++++ bfps/NavierStokes.py | 5 +++++ bfps/_base.py | 5 ++--- bfps/_code.py | 5 ++--- bfps/_fluid_base.py | 4 ++++ 7 files changed, 27 insertions(+), 6 deletions(-) diff --git a/bfps/FluidConvert.py b/bfps/FluidConvert.py index e94031e9..8b322c05 100644 --- a/bfps/FluidConvert.py +++ b/bfps/FluidConvert.py @@ -30,6 +30,11 @@ import os from ._fluid_base import _fluid_particle_base class FluidConvert(_fluid_particle_base): + """This class is meant to be used for conversion of native DNS field + representations to real-space representations of velocity/vorticity + fields. + It may be superseeded by streamlined functionality in the future... + """ def __init__( self, name = 'FluidConvert', diff --git a/bfps/FluidResize.py b/bfps/FluidResize.py index cb145c9d..e9fa8f9f 100644 --- a/bfps/FluidResize.py +++ b/bfps/FluidResize.py @@ -29,6 +29,10 @@ from ._fluid_base import _fluid_particle_base import numpy as np class FluidResize(_fluid_particle_base): + """This class is meant to resize snapshots of DNS states to new grids. + Typical stuff for DNS of turbulence. + It will become superfluous when HDF5 is used for field I/O. + """ def __init__( self, name = 'FluidResize', diff --git a/bfps/Launcher.py b/bfps/Launcher.py index 575f30a9..736ef7ae 100644 --- a/bfps/Launcher.py +++ b/bfps/Launcher.py @@ -34,6 +34,11 @@ from .FluidResize import FluidResize from .FluidConvert import FluidConvert class Launcher: + """Objects of this class are used in the executable bfps script. + It should work with any children of + :class:`NavierStokes <NavierStokes.NavierStokes>`; + failure to do so should be reported as a bug. + """ def __init__( self, base_class = NavierStokes): diff --git a/bfps/NavierStokes.py b/bfps/NavierStokes.py index 6c0c8b3a..187f5b28 100644 --- a/bfps/NavierStokes.py +++ b/bfps/NavierStokes.py @@ -31,6 +31,11 @@ import h5py from ._fluid_base import _fluid_particle_base class NavierStokes(_fluid_particle_base): + """Objects of this class can be used to generate production DNS codes. + Any functionality that users require should be available through this class, + in the sense that they can implement whatever they need by simply inheriting + this class. + """ def __init__( self, name = 'NavierStokes', diff --git a/bfps/_base.py b/bfps/_base.py index 286ebc62..decfaaa7 100644 --- a/bfps/_base.py +++ b/bfps/_base.py @@ -31,9 +31,8 @@ import h5py from bfps import install_info class _base(object): - """ - This class contains simulation parameters, and handles parameter related - functionalities of both python objects and C++ codes. + """This class contains simulation parameters, and handles parameter related + functionalities of both python objects and C++ codes. """ def __init__( self, diff --git a/bfps/_code.py b/bfps/_code.py index 3ec9f4fc..c0f019fc 100644 --- a/bfps/_code.py +++ b/bfps/_code.py @@ -36,9 +36,8 @@ import bfps from ._base import _base class _code(_base): - """ - This class is meant to stitch together the C++ code into a final source file, - compile it, and handle all job launching. + """This class is meant to stitch together the C++ code into a final source file, + compile it, and handle all job launching. """ def __init__( self, diff --git a/bfps/_fluid_base.py b/bfps/_fluid_base.py index 4e1a6c6c..e51bd0dc 100644 --- a/bfps/_fluid_base.py +++ b/bfps/_fluid_base.py @@ -32,6 +32,10 @@ import numpy as np import h5py class _fluid_particle_base(_code): + """This class is meant to put together all common code between the + different C++ solvers/postprocessing tools, so that development of + specific functionalities is not overwhelming. + """ def __init__( self, name = 'solver', -- GitLab