metaStuffWrapper3D.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 META_STUFF_WRAPPER_3D_H
00029 #define META_STUFF_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/metaStuffFunctional3D.h"
00037 #include <memory>
00038 
00039 namespace plb {
00040 
00041 template<typename T, template<typename U> class Descriptor>
00042 void extractTopMostDynamics(MultiBlockLattice3D<T,Descriptor>& lattice, MultiScalarField3D<int>& dynamicsId,
00043                             Box3D domain );
00044 
00045 template<typename T, template<typename U> class Descriptor>
00046 std::auto_ptr< MultiScalarField3D<int> > extractTopMostDynamics (
00047                                              MultiBlockLattice3D<T,Descriptor>& lattice );
00048 
00049 template<typename T, template<typename U> class Descriptor>
00050 std::auto_ptr< MultiScalarField3D<int> > extractTopMostDynamics (
00051                                              MultiBlockLattice3D<T,Descriptor>& lattice, Box3D domain );
00052 
00053 
00054 template<typename T, template<typename U> class Descriptor>
00055 void extractBottomMostDynamics(MultiBlockLattice3D<T,Descriptor>& lattice, MultiScalarField3D<int>& dynamicsId,
00056                             Box3D domain );
00057 
00058 template<typename T, template<typename U> class Descriptor>
00059 std::auto_ptr< MultiScalarField3D<int> > extractBottomMostDynamics (
00060                                              MultiBlockLattice3D<T,Descriptor>& lattice );
00061 
00062 template<typename T, template<typename U> class Descriptor>
00063 std::auto_ptr< MultiScalarField3D<int> > extractBottomMostDynamics (
00064                                              MultiBlockLattice3D<T,Descriptor>& lattice, Box3D domain );
00065 
00066 template<typename T, template<typename U> class Descriptor>
00067 void uniqueDynamicsChains (
00068         MultiBlockLattice3D<T,Descriptor>& lattice, Box3D domain,
00069         std::vector<std::vector<int> >& chains, pluint& maxChainLength );
00070 
00071 template<typename T, template<typename U> class Descriptor>
00072 void uniqueDynamicsIds (
00073         MultiBlockLattice3D<T,Descriptor>& lattice, Box3D domain, std::vector<int>& ids );
00074 
00075 template<typename T, template<typename U> class Descriptor>
00076 void extractDynamicsChain(MultiBlockLattice3D<T,Descriptor>& lattice, MultiScalarField3D<int>& dynamicsId,
00077                           std::map<int,std::string>& nameOfDynamics, Box3D domain );
00078 
00079 template<typename T, template<typename U> class Descriptor>
00080 std::auto_ptr< MultiScalarField3D<int> > extractDynamicsChain (
00081             MultiBlockLattice3D<T,Descriptor>& lattice,
00082             std::map<int,std::string>& nameOfDynamics );
00083 
00084 template<typename T, template<typename U> class Descriptor>
00085 std::auto_ptr< MultiScalarField3D<int> > extractDynamicsChain (
00086             MultiBlockLattice3D<T,Descriptor>& lattice,
00087             std::map<int,std::string>& nameOfDynamics, Box3D domain );
00088 
00089 
00090 template<typename T, template<typename U> class Descriptor>
00091 void copyEntireCells( MultiBlockLattice3D<T,Descriptor>& sourceLattice,
00092                       MultiBlockLattice3D<T,Descriptor>& destinationLattice,
00093                       Box3D domain );
00094 
00095 template<typename T, template<typename U> class Descriptor>
00096 std::auto_ptr< MultiBlockLattice3D<T,Descriptor> > copyEntireCells (
00097             MultiBlockLattice3D<T,Descriptor>& lattice );
00098 
00099 template<typename T, template<typename U> class Descriptor>
00100 std::auto_ptr< MultiBlockLattice3D<T,Descriptor> > copyEntireCells (
00101             MultiBlockLattice3D<T,Descriptor>& lattice, Box3D domain );
00102 
00103 bool allFlagsTrue(MultiBlock3D* multiBlock);
00104 
00105 void getThreadNum(MultiScalarField3D<int>& threadNum);
00106 
00107 void getBlockNum(MultiScalarField3D<plint>& blockNum);
00108 
00109 void getRandomBlockNum(MultiScalarField3D<plint>& blockNum);
00110 
00111 }  // namespace plb
00112 
00113 #endif  // META_STUFF_WRAPPER_3D_H