/*
 *    vmg - a versatile multigrid solver
 *    Copyright (C) 2012 Institute for Numerical Simulation, University of Bonn
 *
 *  vmg 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 3 of the License, or
 *  (at your option) any later version.
 *
 *  vmg 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, see <http://www.gnu.org/licenses/>.
 */

/**
 * @file   com_set_average_to_zero.cpp
 * @author Julian Iseringhausen <isering@ins.uni-bonn.de>
 * @date   Mon Apr 18 12:49:11 2011
 *
 * @brief  May be used to ensure the global constraint
 *         \sum_{i,j,k} sol_{i,j,k} = 0
 *
 */

#ifdef HAVE_CONFIG_H
#include <libvmg_config.h>
#endif

#include "base/command.hpp"
#include "base/factory.hpp"
#include "grid/grid.hpp"
#include "grid/multigrid.hpp"

using namespace VMG;

class VMGCommandSetAverageToZero : public Command
{
public:
  Request Run(Command::argument_vector arguments)
  {
    MPE_EVENT_BEGIN()

    (*MG::GetFactory().Get(arguments[0])->Cast<Multigrid>())().SetAverageToZero();

    MPE_EVENT_END()

    return Continue;
  }

  static const char* Name() {return "SetAverageToZero";}
  static int Arguments() {return 1;}
};

CREATE_INITIALIZER(VMGCommandSetAverageToZero)