#--------------------------------------------------------------------------------------
README
#--------------------------------------------------------------------------------------
# managedFlu - OpenFOAM C++ interactive functionality API
# Copyright (C) 2011- Alexey Petrov
# 
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
# 
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
# 
# You should have received a copy of the GNU General Public Licens e
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
#
# See http://sourceforge.net/projects/pythonflu
#
# Author : Alexey PETROV, Andrey Simurzin


#--------------------------------------------------------------------------------------
Introduction
#--------------------------------------------------------------------------------------

"managedFlu" is a C++ library that allows to write interactive functionality on top of 
referenced OpenFOAM API. As it has appeared, OpenFOAM imposes limitations on writing 
corresponding solver code, namely - most OpenFOAM objects should live in the same "scope"
and exactly within the same time (that is why solver expands its functionality by usage 
of "#include" tricks). If one of the objects die unexpectedly, all others can not be used
anymore. Such specific assumptions made by OpenFOAM make it impossible to write a 
functionality which can be used many times in during the same session (something the other
"pythonFlu" package are going to provide to). managedFlu provides a general solution for this
case by introducing an additional "managed" level for the referenced OpenFOAM C++ API. 
All the developers need to do, to be able to write interactive applications, it is to create 
and use corresponding "managed" OpenFOAM objects instead of the referenced ones. For more details 
developers can check corresponding solver examples that comes with managedFlu as a its demonstration.
 
#--------------------------------------------------------------------------------------
Installation
#--------------------------------------------------------------------------------------

See the INSTALL file for more information about installing of managedFlu
library.

#--------------------------------------------------------------------------------------
Usage
#--------------------------------------------------------------------------------------

(see corresponding C++ API)

#--------------------------------------------------------------------------------------