Line data    Source code

       1             : /* +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
       2             :    Copyright (c) 2013-2023 The plumed team
       3             :    (see the PEOPLE file at the root of the distribution for a list of names)
       4             : 
       5             :    See http://www.plumed.org for more information.
       6             : 
       7             :    This file is part of plumed, version 2.
       8             : 
       9             :    plumed is free software: you can redistribute it and/or modify
      10             :    it under the terms of the GNU Lesser General Public License as published by
      11             :    the Free Software Foundation, either version 3 of the License, or
      12             :    (at your option) any later version.
      13             : 
      14             :    plumed is distributed in the hope that it will be useful,
      15             :    but WITHOUT ANY WARRANTY; without even the implied warranty of
      16             :    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
      17             :    GNU Lesser General Public License for more details.
      18             : 
      19             :    You should have received a copy of the GNU Lesser General Public License
      20             :    along with plumed.  If not, see <http://www.gnu.org/licenses/>.
      21             : +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ */
      22             : #include "core/ActionShortcut.h"
      23             : #include "core/ActionRegister.h"
      24             : 
      25             : //+PLUMEDOC MCOLVAR DENSITY
      26             : /*
      27             : Depreciated command that is bascially equivalant to GROUP.
      28             : 
      29             : Here is an example but Plase don't use this anymore.  Use [GROUP](GROUP.md) instead.
      30             : 
      31             : ```plumed
      32             : g1: DENSITY SPECIES=1-100
      33             : DUMPATOMS ATOMS=g1 FILE=group.xyz
      34             : ```
      35             : 
      36             : */
      37             : //+ENDPLUMEDOC
      38             : 
      39             : namespace PLMD {
      40             : namespace volumes {
      41             : 
      42             : class Density : public ActionShortcut {
      43             : public:
      44             :   static void registerKeywords(Keywords& keys);
      45             :   explicit Density(const ActionOptions&);
      46             : };
      47             : 
      48             : PLUMED_REGISTER_ACTION(Density,"DENSITY")
      49             : 
      50           2 : void Density::registerKeywords(Keywords& keys) {
      51           2 :   ActionShortcut::registerKeywords( keys );
      52           4 :   keys.setDeprecated("GROUP");
      53           2 :   keys.add("compulsory","SPECIES","the atoms in the group");
      54           4 :   keys.setValueDescription("atoms","indices for the specified group of atoms");
      55           2 :   keys.needsAction("ONES");
      56           2 :   keys.needsAction("GROUP");
      57           2 : }
      58             : 
      59           0 : Density::Density(const ActionOptions& ao):
      60             :   Action(ao),
      61           0 :   ActionShortcut(ao) {
      62             :   std::string atoms;
      63           0 :   parse("SPECIES",atoms);
      64           0 :   warning("This action has been depracated.  Look at the log to see how the same result is achieved with the new syntax");
      65           0 :   readInputLine( getShortcutLabel() + ": GROUP ATOMS=" + atoms);
      66           0 : }
      67             : 
      68             : }
      69             : }