/******************************************************************************
* NOMAD -  Nonlinear Optimization for Mixed vAriables and Derivatives.        *
* Copyright (C) 2001-2004  Gilles Couture - Ecole Polytechnique,              *
*                          Charles Audet - Ecole Polytechnique,               *
*		           John Dennis - Rice University.                     *
*                                                                             *
* Author: Gilles Couture                                                      *
* École Polytechnique de Montréal - GERAD                                     *
* C.P. 6079, Succ. Centre-ville, Montréal (Québec) H3C 3A7 Canada             *
* Tel:  (514) 340-6053 x6928                                                  *
* Email: Gilles.Couture@gerad.ca                                              *
* Fax: (514) 340-5665                                                         *
*                                                                             *
* 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. You can find the              *
* GNU General Public License at:                                              *
*             http://www.gnu.org/copyleft/gpl.html                            *
*                                                                             *
* 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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA. *
*                                                                             *
* You can find information on the NOMAD software at:                          *
*             http://www.gerad.ca/NOMAD/                                      *
******************************************************************************/

// mesh.h -- class definition for Mesh. This class controls the update of the
// mesh when there is a success or failure in the poll.

#ifndef _MESH_H_
#define _MESH_H_

class Description;
class Parameters;

class Mesh
{
  // The Mesh object has the following variables:
  // - 'max_mesh_size' is the maximum mesh size that can be reached in a run.
  // - 'mesh_size' is the current mesh size.
  // - 'mesh_size_term' is the mesh size termination criterion.
  // - 'display_factor' is used for debugging.
  // - Constant pointers to 'Description' and 'Parameters'.
 private:
  double max_mesh_size, mesh_size, mesh_size_term;
  int display_factor;
  const Description * const description;
  const Parameters * const parameters;

  // These methods are described in "mesh.cpp".
  void calculateMeshSizes();

 public:
  Mesh(const Description * const des, const Parameters * const par);
  ~Mesh();
  bool refine();
  void coarsen();
  void showInput(ofstream & fout) const;

  // Inline methods.
  // ---------------

  // This method returns the value of 'mesh_size'.
  double getMeshSize() const {return mesh_size;}
  // This method returns the mesh size termination criterion..
  double getMeshSizeTerm() const {return mesh_size_term;}
  // The display factor has been reset.
  void setDisplay(const int display) {display_factor = display;}
};
#endif
