freeSurfacePostProcessor3D.h

Go to the documentation of this file.

/*  This file is part of the OpenLB library
 *
 *  Copyright (C) 2021 Claudius Holeksa
 *  E-mail contact: info@openlb.net
 *  The most recent release of OpenLB can be downloaded at
 *  <http://www.openlb.net/>
 *
 *  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.
*/
 
#pragma once
 
#include "dynamics/descriptorField.h"
#include "dynamics/freeSurfaceHelpers.h"
#include "core/postProcessing.h"
#include "core/blockLattice.h"
 
namespace olb {
 
template<typename T, typename DESCRIPTOR>
class FreeSurfaceMassFlowPostProcessor3D {
public:
  using parameters = meta::list<
    FreeSurface::DROP_ISOLATED_CELLS,
    FreeSurface::TRANSITION,
    FreeSurface::LONELY_THRESHOLD,
    FreeSurface::HAS_SURFACE_TENSION,
    FreeSurface::SURFACE_TENSION_PARAMETER,
    FreeSurface::FORCE_CONVERSION_FACTOR,
    FreeSurface::LATTICE_SIZE
  >;
 
  static constexpr OperatorScope scope = OperatorScope::PerCellWithParameters;
 
  int getPriority() const {
    return 1;
  }
 
  template <typename CELL, typename PARAMETERS>
  void apply(CELL& cell, PARAMETERS& parameters) any_platform;
 
};
 
/*
 * Free Surface Processor 4
 * ToFluid
 * Converts cells to interface from gas if a neighbouring cell was converted to a fluid cell
 */
template<typename T, typename DESCRIPTOR>
class FreeSurfaceToFluidCellConversionPostProcessor3D  {
public:
  static constexpr OperatorScope scope = OperatorScope::PerCell;
 
  int getPriority() const {
    return 4;
  }
 
  template <typename CELL>
  void apply(CELL& cell) any_platform;
 
};
 
template<typename T, typename DESCRIPTOR>
class FreeSurfaceToGasCellConversionPostProcessor3D  {
public:
  static constexpr OperatorScope scope = OperatorScope::PerCell;
 
  int getPriority() const {
    return 5;
  }
 
  template <typename CELL>
  void apply(CELL& cell) any_platform;
 
};
 
template<typename T, typename DESCRIPTOR>
class FreeSurfaceMassExcessPostProcessor3D  {
public:
  static constexpr OperatorScope scope = OperatorScope::PerCell;
 
  int getPriority() const {
    return 6;
  }
 
  template <typename CELL>
  void apply(CELL& cell) any_platform;
 
};
 
template<typename T, typename DESCRIPTOR>
class FreeSurfaceFinalizeConversionPostProcessor3D {
public:
  static constexpr OperatorScope scope = OperatorScope::PerCell;
 
  int getPriority() const {
    return 7;
  }
 
  template <typename CELL>
  void apply(CELL& cell) any_platform;
 
};
 
/*
* Setup helper
*/
template<typename T, typename DESCRIPTOR>
class FreeSurface3DSetup {
public:
private:
  SuperLattice<T, DESCRIPTOR>& sLattice;
 
  // SuperPostProcessors
  // Corresponding to the local block processors
public:
  FreeSurface3DSetup(SuperLattice<T, DESCRIPTOR>& sLattice);
 
  void addPostProcessor();
};
 
}