// macro.h --- preferential flow.
// 
// Copyright 1996-2001 Per Abrahamsen and Søren Hansen
// Copyright 2000-2001 KVL.
//
// This file is part of Daisy.
// 
// Daisy is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser Public License as published by
// the Free Software Foundation; either version 2.1 of the License, or
// (at your option) any later version.
// 
// Daisy 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 Lesser Public License for more details.
// 
// You should have received a copy of the GNU Lesser Public License
// along with Daisy; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA


#ifndef MACRO_H
#define MACRO_H

#include "model.h"
#include "symbol.h"

#include <vector>
#include <memory>

class Geometry1D;
class Soil;
class Log;
class Surface;
class Treelog;
class BlockModel;

class Macro : public Model
{
  // Content.
public:
  const symbol name;
  static const char *const component;
  symbol library_id () const;
  virtual bool none () const;

  // Simulation.
public:
  virtual void tick (const Geometry1D& geo,
                     const Soil& soil, size_t first, size_t last,
		     Surface& surface,
		     const std::vector<double>& h_ice,
		     const std::vector<double>& h,
		     const std::vector<double>& Theta,
		     std::vector<double>& S,
		     std::vector<double>& S_p,
		     std::vector<double>& q_p, 
                     double dt, Treelog&) = 0;
  virtual void output (Log&) const = 0;

  // Create and Destroy.
public:
  static std::auto_ptr<Macro> create (double depth); // Defined in macro_std.C.
protected:
  Macro (const BlockModel& al);
  Macro (symbol id);
public:
  ~Macro ();
};

#endif // MACRO_H
