blocklatticeview2d.h

open lattice boltzmann project www.openlb.org

/*  This file is part of the OpenLB library
 *
 *  Copyright (C) 2006, 2007 Jonas Latt
 *  Address: Rue General Dufour 24,  1211 Geneva 4, Switzerland 
 *  E-mail: [e-mail]
 *
 *  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 2
 *  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 
 *  License along with this program; if not, write to the Free 
 *  Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 *  Boston, MA  02110-1301, USA.
*/

/** \file
 * Dynamics for a generic 2D block lattice view -- header file.
 */
#ifndef BLOCK_LATTICE_VIEW_2D_H
#define BLOCK_LATTICE_VIEW_2D_H

#include <vector>
#include "blockStructure2D.h"
#include "dataAnalysisBase2D.h"

namespace olb {

template<typename T, template<typename U> class Lattice> class DataAnalysis2D;

template<typename T, template<typename U> class Lattice> class BlockLatticeViewSerializer2D;
template<typename T, template<typename U> class Lattice> class BlockLatticeViewUnSerializer2D;

/// A rectangular extract from a given BlockStructure.
/** Attention:
 * - This class can only be applied to already existing BlockLattices.
 * - The postProcessors of the original BlockLattice are not called any
 *   more. New, appropriate PostProcessors are generated instead.
 */
template<typename T, template<typename U> class Lattice>
class BlockLatticeView2D : public BlockStructure2D<T,Lattice> {
public:
    BlockLatticeView2D(BlockStructure2D<T,Lattice>& originalLattice_);
    BlockLatticeView2D(BlockStructure2D<T,Lattice>& originalLattice_,
                       int x0_, int x1_, int y0_, int y1_);
    ~BlockLatticeView2D();
    BlockLatticeView2D(BlockLatticeView2D const& rhs);
    BlockLatticeView2D<T,Lattice>& operator= 
      (BlockLatticeView2D<T,Lattice> const& rhs);
    void swap(BlockLatticeView2D<T,Lattice>& rhs);

    virtual int getNx() const { return nx; }
    virtual int getNy() const { return ny; }
    virtual Cell<T,Lattice>& get(int iX, int iY);
    virtual Cell<T,Lattice> const& get(int iX, int iY) const;
    virtual void initialize();
    virtual void defineDynamics (
        int x0_, int x1_, int y0_, int y1_,
        Dynamics<T,Lattice>* dynamics );
    virtual void defineDynamics(int iX, int iY, Dynamics<T,Lattice>* dynamics );
    virtual void specifyStatisticsStatus (
                int x0_, int x1_, int y0_, int y1_, bool status );
    virtual void collide(int x0_, int x1_, int y0_, int y1_);
    virtual void collide();
    virtual void staticCollide (int x0, int x1, int y0, int y1,
                                TensorFieldBase2D<T,2> const& u);
    virtual void staticCollide (TensorFieldBase2D<T,2> const& u);
    virtual void stream(int x0_, int x1_, int y0_, int y1_);
    virtual void collideAndStream(int x0_, int x1_, int y0_, int y1_);
    virtual void stream(bool periodic=false);
    virtual void collideAndStream(bool periodic=false);
    virtual T computeAverageDensity(int x0_, int x1_, int y0_, int y1_) const;
    virtual T computeAverageDensity() const;
    virtual void stripeOffDensityOffset (
            int x0_, int x1_, int y0_, int y1_, T offset );
    virtual void stripeOffDensityOffset(T offset);
    virtual void forAll(int x0_, int x1_, int y0_, int y1_,
                        WriteCellFunctional<T,Lattice> const& application);
    virtual void forAll(WriteCellFunctional<T,Lattice> const& application);
    virtual void addPostProcessor (
                     PostProcessorGenerator2D<T,Lattice> const& ppGen);
    virtual void resetPostProcessors();
    virtual void postProcess(int x0_, int x1_, int y0_, int y1_);
    virtual void postProcess();
    virtual void addLatticeCoupling (
                     LatticeCouplingGenerator2D<T,Lattice> const& lcGen,
                     std::vector<SpatiallyExtendedObject2D*> partners );
    virtual void executeCoupling(int x0_, int x1_, int y0_, int y1_);
    virtual void executeCoupling();
    virtual void subscribeReductions(Reductor<T>& reductor);
    virtual LatticeStatistics<T>& getStatistics();
    virtual LatticeStatistics<T> const& getStatistics() const;
    virtual DataAnalysisBase2D<T,Lattice> const& getDataAnalysis() const;
    virtual DataSerializer<T> const& getSerializer(IndexOrdering::OrderingT ordering) const;
    virtual DataUnSerializer<T>& getUnSerializer(IndexOrdering::OrderingT ordering);
    virtual DataSerializer<T> const& getSubSerializer (
            int x0_, int x1_, int y0_, int y1_,
            IndexOrdering::OrderingT ordering ) const;
    virtual DataUnSerializer<T>& getSubUnSerializer (
            int x0_, int x1_, int y0_, int y1_,
            IndexOrdering::OrderingT ordering );
    virtual MultiDataDistribution2D getDataDistribution() const;
    virtual SpatiallyExtendedObject2D* getComponent(int iBlock);
    virtual SpatiallyExtendedObject2D const* getComponent(int iBlock) const;
    virtual multiPhysics::MultiPhysicsId getMultiPhysicsId() const;
private:
    BlockStructure2D<T,Lattice>  *originalLattice;
    int                          x0, y0;
    int                          nx,ny;
    DataAnalysis2D<T,Lattice>    *dataAnalysis;
};

}  // namespace olb

#endif