LimiterType.h

Go to the documentation of this file.

// -*- C++ -*-

// Copyright (C) 2002 Ralf Deiterding
// Brandenburgische Universitaet Cottbus
//
// Copyright (C) 2003-2007 California Institute of Technology
// Ralf Deiterding, ralf@amroc.net

#ifndef AMROC_LIMITERTYPE_H
#define AMROC_LIMITERTYPE_H

#include "Criteria/LimiterCriterion.h"

template <class VectorType, class FlagType, int dim>
class LimiterType : 
  public LimiterCriterion<VectorType,FlagType,dim> {
  typedef typename VectorType::InternalDataType DataType;
  typedef LimiterCriterion<VectorType,FlagType,dim> base;
public:
  typedef typename base::vec_grid_fct_type vec_grid_fct_type;  
  typedef typename base::grid_fct_type grid_fct_type;
  typedef typename base::flag_fct_type flag_fct_type;
  typedef typename base::max_vector_type max_vector_type;

  LimiterType() : base() {
    base::SetShadowCriterion(false);
    Maxv = static_cast<DataType>(0.0);
    Tol = static_cast<DataType>(0.0);
    Sc = static_cast<DataType>(0.0);
    ScTol = static_cast<DataType>(0.0);
  }

  virtual ~LimiterType() {}
  
  virtual void register_at(ControlDevice& Ctrl) {}
  virtual void register_at(ControlDevice& Ctrl, const std::string& prefix) {
    base::LocCtrl = Ctrl.getSubDevice(prefix+"LimiterType");
    char Name[16];
    for (int d=0; d<max_vector_type::Length(); d++) {
      std::sprintf(Name,"Max(%d)",d+1);
      RegisterAt(base::LocCtrl,Name,Maxv(d));
      std::sprintf(Name,"Tol(%d)",d+1);
      RegisterAt(base::LocCtrl,Name,Tol(d));
      std::sprintf(Name,"ScTol(%d)",d+1);     
      RegisterAt(base::LocCtrl,Name,ScTol(d));
      std::sprintf(Name,"MaxLev(%d)",d+1);
      RegisterAt(base::LocCtrl,Name,base::_MaxLevel[d]);
    }    
    RegisterAt(base::LocCtrl,"Output",base::_Output);
  }

  virtual void update() { 
    Sc = ScTol*Maxv;
    int d=max_vector_type::Length();
    for (; d>0; d--) 
      if (Tol(d-1)>static_cast<DataType>(0.0) &&
          Sc(d-1)>static_cast<DataType>(0.0)) 
        break;
    if (d>0) {
      base::SetNcnt(d);
      base::SetIsUsed(true);
    }
    else 
      base::SetIsUsed(false);
  }

  virtual bool SetFlags(vec_grid_fct_type& u, grid_fct_type& work, flag_fct_type& flags, 
                        const int& cnt, const int& Time, const int& Level, const double& t, 
                        const FlagType& FlagValue) {
    if (Tol(cnt)<=0.0 || Sc(cnt)<=0.0) return false;
    int TStep = TimeStep(work,Level);
    if (base::MaxLevel(cnt)<Level && base::MaxLevel(cnt)>=0) {
      if (base::OutputFlags()) {
        forall(work,Time,Level,c)
          work(Time+TStep,Level,c) = static_cast<DataType>(0.0);
        end_forall 
      }
      return true;
    }

    forall(work,Time,Level,c)
      equals_from(work(Time,Level,c), u(Time,Level,c), cnt);
    end_forall 
    return FlagByLimiter(work, flags, Time, Level, Tol(cnt), Sc(cnt), FlagValue);
  }

  virtual bool FlagByLimiter(grid_fct_type& work, flag_fct_type& flags,
                             const int& Time, const int& Level, 
                             const DataType& TolVal, const DataType& ScVal, 
                             const FlagType& FlagValue) { 
    if (TolVal<=0.0 || ScVal<=0.0) return false;
    int TStep = TimeStep(work,Level);
    forall(work,Time,Level,c)
      work(Time+TStep,Level,c) = static_cast<DataType>(1.0);
    end_forall 

    int OffsetX[3]  = { 1, 0, 0 }; int OffsetY[3]  = { 0, 1, 0 }; int OffsetZ[3]  = { 0, 0, 1 }; 
    base::Limiter(work, Time, Level, OffsetX, ScVal);
    if (dim > 1) base::Limiter(work, Time, Level, OffsetY, ScVal);
    if (dim > 2) base::Limiter(work, Time, Level, OffsetZ, ScVal);
    base::FlagByValue(work, flags, Time, Level, TolVal, FlagValue, 1);
    return true;
  }

  virtual void OutputName(char* name, int cnt) { std::sprintf(name,"limtype_%d",cnt+1); }

  virtual DataType phi(const DataType theta) {
    return (4.*theta/((1.+theta)*(1.+theta)));
  }

  max_vector_type Tol, ScTol, Sc, Maxv;
};

#endif

---