ConditionalEstimator.h

// ============================================================================
// ==                                                                        ==
// == AMDiS - Adaptive multidimensional simulations                          ==
// ==                                                                        ==
// ============================================================================
// ==                                                                        ==
// ==  crystal growth group                                                  ==
// ==                                                                        ==
// ==  Stiftung caesar                                                       ==
// ==  Ludwig-Erhard-Allee 2                                                 ==
// ==  53175 Bonn                                                            ==
// ==  germany                                                               ==
// ==                                                                        ==
// ============================================================================
// ==                                                                        ==
// ==  http://www.caesar.de/cg/AMDiS                                         ==
// ==                                                                        ==
// ============================================================================

/** \file ConditionalEstimator.h */

/** \defgroup Estimator Estimator module
 * @{ <img src="estimator.png"> @}
 */

#ifndef AMDIS_CONDITIONALESTIMATOR_H
#define AMDIS_CONDITIONALESTIMATOR_H

#include "Estimator.h"

namespace AMDiS {

  /**
   * \ingroup Estimator
   * 
   * \brief
   * Estimator for scalar problems.
   */
  class ConditionalEstimator : public Estimator
  {
  public:
    /**
     * Reads the estimateOuter parameter. default value is false! 
     * (i.e.: the ouer part is not estimated)
     */
    ConditionalEstimator(Estimator *decorated);

    double estimate(double timestep);

    inline int getElementCount() 
    {
      return elementCount_;
    }

    inline Estimator *getDecoratedEstimator() 
    { 
      return decoratedEstimator_; 
    }

  protected:
    Estimator *decoratedEstimator_;

    int elementCount_;

    int row_;
  
    bool estimateOut;
  };

}