fdWrapper3D.h

00001 /* This file is part of the Palabos library.
00002  *
00003  * Copyright (C) 2011 FlowKit Sarl
00004  * Avenue de Chailly 23
00005  * 1012 Lausanne, Switzerland
00006  * E-mail contact: contact@flowkit.com
00007  *
00008  * The most recent release of Palabos can be downloaded at 
00009  * <http://www.palabos.org/>
00010  *
00011  * The library Palabos is free software: you can redistribute it and/or
00012  * modify it under the terms of the GNU Affero General Public License as
00013  * published by the Free Software Foundation, either version 3 of the
00014  * License, or (at your option) any later version.
00015  *
00016  * The library is distributed in the hope that it will be useful,
00017  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00018  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00019  * GNU Affero General Public License for more details.
00020  *
00021  * You should have received a copy of the GNU Affero General Public License
00022  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
00023 */
00024 
00028 #ifndef FINITE_DIFFERENCE_WRAPPER_3D_H
00029 #define FINITE_DIFFERENCE_WRAPPER_3D_H
00030 
00031 #include "core/globalDefs.h"
00032 #include "atomicBlock/blockLattice3D.h"
00033 #include "atomicBlock/dataField3D.h"
00034 #include "multiBlock/multiBlockLattice3D.h"
00035 #include "multiBlock/multiDataField3D.h"
00036 #include "dataProcessors/dataAnalysisFunctional3D.h"
00037 #include <memory>
00038 
00039 
00040 namespace plb {
00041 
00042 template<typename T>
00043 void computeXderivative(MultiScalarField3D<T>& value, MultiScalarField3D<T>& derivative, Box3D const& domain);
00044 
00045 template<typename T>
00046 std::auto_ptr<MultiScalarField3D<T> > computeXderivative(MultiScalarField3D<T>& value, Box3D const& domain);
00047 
00048 template<typename T>
00049 std::auto_ptr<MultiScalarField3D<T> > computeXderivative(MultiScalarField3D<T>& value);
00050 
00051 template<typename T>
00052 void computeYderivative(MultiScalarField3D<T>& value, MultiScalarField3D<T>& derivative, Box3D const& domain);
00053 
00054 template<typename T>
00055 std::auto_ptr<MultiScalarField3D<T> > computeYderivative(MultiScalarField3D<T>& value, Box3D const& domain);
00056 
00057 template<typename T>
00058 std::auto_ptr<MultiScalarField3D<T> > computeYderivative(MultiScalarField3D<T>& value);
00059 
00060 template<typename T>
00061 void computeZderivative(MultiScalarField3D<T>& value, MultiScalarField3D<T>& derivative, Box3D const& domain);
00062 
00063 template<typename T>
00064 std::auto_ptr<MultiScalarField3D<T> > computeZderivative(MultiScalarField3D<T>& value, Box3D const& domain);
00065 
00066 template<typename T>
00067 std::auto_ptr<MultiScalarField3D<T> > computeZderivative(MultiScalarField3D<T>& value);
00068 
00069 template<typename T>
00070 void computeGradientNorm(MultiScalarField3D<T>& value, MultiScalarField3D<T>& derivative, Box3D const& domain);
00071 
00072 template<typename T>
00073 std::auto_ptr<MultiScalarField3D<T> > computeGradientNorm(MultiScalarField3D<T>& value, Box3D const& domain);
00074 
00075 template<typename T>
00076 std::auto_ptr<MultiScalarField3D<T> > computeGradientNorm(MultiScalarField3D<T>& value);
00077 
00078 template<typename T>
00079 std::auto_ptr<MultiScalarField3D<T> > computePoissonRHS(MultiTensorField3D<T,3>& velocity, Box3D const& domain);
00080 
00081 template<typename T>
00082 std::auto_ptr<MultiScalarField3D<T> > computePoissonRHS(MultiTensorField3D<T,3>& velocity);
00083 
00084 
00085 template<typename T>
00086 void poissonIterate(MultiScalarField3D<T>& oldPressure, MultiScalarField3D<T>& newPressure,
00087                     MultiScalarField3D<T>& rhs, T beta, Box3D const& domain, plint boundaryWidth = 1);
00088 
00089 template<typename T>
00090 T computePoissonResidue(MultiScalarField3D<T>& pressure, MultiScalarField3D<T>& rhs, Box3D const& domain);
00091 
00092 // ========================================================================= //
00093 // PERIODIC VERSIONS OF THE DERIVATIVES AND POISSON SCHEMES //
00094 // ========================================================================= //
00095 
00096 template<typename T>
00097 void computeXperiodicDerivative(MultiScalarField3D<T>& value, MultiScalarField3D<T>& derivative, Box3D const& domain);
00098 
00099 template<typename T>
00100 std::auto_ptr<MultiScalarField3D<T> > computeXperiodicDerivative(MultiScalarField3D<T>& value, Box3D const& domain);
00101 
00102 template<typename T>
00103 std::auto_ptr<MultiScalarField3D<T> > computeXperiodicDerivative(MultiScalarField3D<T>& value);
00104 
00105 template<typename T>
00106 void computeYperiodicDerivative(MultiScalarField3D<T>& value, MultiScalarField3D<T>& derivative, Box3D const& domain);
00107 
00108 template<typename T>
00109 std::auto_ptr<MultiScalarField3D<T> > computeYperiodicDerivative(MultiScalarField3D<T>& value, Box3D const& domain);
00110 
00111 template<typename T>
00112 std::auto_ptr<MultiScalarField3D<T> > computeYperiodicDerivative(MultiScalarField3D<T>& value);
00113 
00114 template<typename T>
00115 void computeZperiodicDerivative(MultiScalarField3D<T>& value, MultiScalarField3D<T>& derivative, Box3D const& domain);
00116 
00117 template<typename T>
00118 std::auto_ptr<MultiScalarField3D<T> > computeZperiodicDerivative(MultiScalarField3D<T>& value, Box3D const& domain);
00119 
00120 template<typename T>
00121 std::auto_ptr<MultiScalarField3D<T> > computeZperiodicDerivative(MultiScalarField3D<T>& value);
00122 
00123 template<typename T>
00124 void computePeriodicGradientNorm(MultiScalarField3D<T>& value, MultiScalarField3D<T>& derivative, Box3D const& domain);
00125 
00126 template<typename T>
00127 std::auto_ptr<MultiScalarField3D<T> > computePeriodicGradientNorm(MultiScalarField3D<T>& value, Box3D const& domain);
00128 
00129 template<typename T>
00130 std::auto_ptr<MultiScalarField3D<T> > computePeriodicGradientNorm(MultiScalarField3D<T>& value);
00131 
00132 template<typename T>
00133 std::auto_ptr<MultiScalarField3D<T> > computePeriodicPoissonRHS(MultiTensorField3D<T,3>& velocity, Box3D const& domain);
00134 
00135 template<typename T>
00136 std::auto_ptr<MultiScalarField3D<T> > computePeriodicPoissonRHS(MultiTensorField3D<T,3>& velocity);
00137 
00138 
00139 template<typename T>
00140 void periodicPoissonIterate(MultiScalarField3D<T>& oldPressure, MultiScalarField3D<T>& newPressure,
00141                            MultiScalarField3D<T>& rhs, T beta, Box3D const& domain);
00142 
00143 }  // namespace plb
00144 
00145 #endif  // FINITE_DIFFERENCE_WRAPPER_3D_H