/* This file is part of the Palabos library.
 *
 * The Palabos softare is developed since 2011 by FlowKit-Numeca Group Sarl
 * (Switzerland) and the University of Geneva (Switzerland), which jointly
 * own the IP rights for most of the code base. Since October 2019, the
 * Palabos project is maintained by the University of Geneva and accepts
 * source code contributions from the community.
 * 
 * Contact:
 * Jonas Latt
 * Computer Science Department
 * University of Geneva
 * 7 Route de Drize
 * 1227 Carouge, Switzerland
 * jonas.latt@unige.ch
 *
 * The most recent release of Palabos can be downloaded at 
 * <https://palabos.unige.ch/>
 *
 * The library Palabos is free software: you can redistribute it and/or
 * modify it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * The library 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef FREE_SURFACE_BOUNDARY_CONDITION_3D_H
#define FREE_SURFACE_BOUNDARY_CONDITION_3D_H

namespace plb {

template<typename T, template<typename U> class Descriptor>
class FreeSurfaceFadingArea3D : public BoxProcessingFunctional3D_L<T,Descriptor>
{
public:
    FreeSurfaceFadingArea3D(T factor_);
    virtual void process(Box3D domain, BlockLattice3D<T,Descriptor>& lattice);
    virtual FreeSurfaceFadingArea3D<T,Descriptor>* clone() const;
    virtual void getTypeOfModification(std::vector<modif::ModifT>& modified) const {
        modified[0] = modif::staticVariables;  // Fluid
    }
private:
    T factor;
};

template< typename T,template<typename U> class Descriptor>
class PouringLiquid3D : public BoxProcessingFunctional3D {
public:
    PouringLiquid3D(Dynamics<T,Descriptor>* dynamicsTemplate_, Array<T,3> injectionVelocity_)
        : dynamicsTemplate(dynamicsTemplate_), injectionVelocity(injectionVelocity_)
    { }
    PouringLiquid3D(PouringLiquid3D<T,Descriptor> const& rhs)
        : dynamicsTemplate(rhs.dynamicsTemplate->clone()),
          injectionVelocity(rhs.injectionVelocity)
    { }
    PouringLiquid3D<T,Descriptor>* operator=(PouringLiquid3D<T,Descriptor> const& rhs)
    { 
        PouringLiquid3D<T,Descriptor>(rhs).swap(*this);
        return *this;
    }
    void swap(PouringLiquid3D<T,Descriptor>& rhs) {
        std::swap(dynamicsTemplate, rhs.dynamicsTemplate);
        std::swap(injectionVelocity, rhs.injectionVelocity);
    }
    virtual ~PouringLiquid3D() {
        delete dynamicsTemplate;
    }
    virtual void processGenericBlocks(Box3D domain, std::vector<AtomicBlock3D*> atomicBlocks);
    virtual PouringLiquid3D<T,Descriptor>* clone() const;
    virtual void getTypeOfModification(std::vector<modif::ModifT>& modified) const {
        modified[0] = modif::dataStructure;    // Fluid
        modified[1] = modif::staticVariables;  // rhoBar.
        modified[2] = modif::staticVariables;  // j.
        modified[3] = modif::staticVariables;  // Mass
        modified[4] = modif::staticVariables;  // Mass-fraction
        modified[5] = modif::staticVariables;  // Flag-status
        modified[6] = modif::nothing;          // Normal
        modified[7] = modif::nothing;          // Interface lists
        modified[8] = modif::nothing;          // Curvature.
        modified[9] = modif::nothing;          // Outside density.
    }
private:
    Dynamics<T,Descriptor>* dynamicsTemplate;
    Array<T,3> injectionVelocity;
};

template< typename T,template<typename U> class Descriptor>
class RemoveMass3D : public BoxProcessingFunctional3D {
public:
    virtual void processGenericBlocks(Box3D domain, std::vector<AtomicBlock3D*> atomicBlocks);
    virtual RemoveMass3D<T,Descriptor>* clone() const;
    virtual void getTypeOfModification(std::vector<modif::ModifT>& modified) const {
        modified[0] = modif::dataStructure;    // Fluid
        modified[1] = modif::staticVariables;  // rhoBar.
        modified[2] = modif::staticVariables;  // j.
        modified[3] = modif::staticVariables;  // Mass
        modified[4] = modif::staticVariables;  // Mass-fraction
        modified[5] = modif::staticVariables;  // Flag-status
        modified[6] = modif::nothing;          // Normal
        modified[7] = modif::nothing;          // Interface lists
        modified[8] = modif::nothing;          // Curvature.
        modified[9] = modif::nothing;          // Outside density.
    }
};

template< typename T,template<typename U> class Descriptor>
class ShortenBounceBack3D : public BoxProcessingFunctional3D {
public:
    virtual void processGenericBlocks(Box3D domain, std::vector<AtomicBlock3D*> atomicBlocks);
    virtual ShortenBounceBack3D<T,Descriptor>* clone() const;
    virtual void getTypeOfModification(std::vector<modif::ModifT>& modified) const {
        modified[0] = modif::dataStructure;    // Fluid
        modified[1] = modif::staticVariables;  // rhoBar.
        modified[2] = modif::staticVariables;  // j.
        modified[3] = modif::staticVariables;  // Mass
        modified[4] = modif::staticVariables;  // Mass-fraction
        modified[5] = modif::staticVariables;  // Flag-status
        modified[6] = modif::nothing;          // Normal
        modified[7] = modif::nothing;          // Interface lists
        modified[8] = modif::nothing;          // Curvature.
        modified[9] = modif::nothing;          // Outside density.
    }
};

template<typename T, template<typename U> class Descriptor>
class FreeSurfaceSpongeZone3D : public BoxProcessingFunctional3D {
public:
    // Constructor for the tanh sponge function.
    //   Nice value for the translation parameters is 0.5.
    //   Nice value for the scale parameters is 0.12.
    FreeSurfaceSpongeZone3D(plint nx_, plint ny_, plint nz_, Array<plint,6> const& numSpongeCells_,
            Array<T,6> const& translationParameters_, Array<T,6> const& scaleParameters_,
            bool incompressibleModel_);
    // Constructor for the cos sponge function.
    FreeSurfaceSpongeZone3D(plint nx_, plint ny_, plint nz_, Array<plint,6> const& numSpongeCells_,
            bool incompressibleModel_);
    virtual void processGenericBlocks(Box3D domain, std::vector<AtomicBlock3D*> blocks);
    virtual FreeSurfaceSpongeZone3D<T,Descriptor>* clone() const;
    virtual void getTypeOfModification(std::vector<modif::ModifT>& modified) const;
private:
    plint nx, ny, nz;                   // Lattice dimensions (taken periodicity under account).
    Array<plint,6> numSpongeCells;      // Width of the sponge zones.
    Array<T,6> translationParameters;   // Translation parameters of the tanh sponge functions.
    Array<T,6> scaleParameters;         // Scaling parameters of the tanh sponge functions.
    bool incompressibleModel;           // Is the dynamics comressible or incompressible?
    bool useTanhSpongeFunction;         // Use a tanh sponge function, or a cos sponge function.
};

}  // namespace plb

#endif  // FREE_SURFACE_BOUNDARY_CONDITION_3D_H

