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 "VesselRegister.h"
      23             : #include "FunctionVessel.h"
      24             : #include "ActionWithVessel.h"
      25             : 
      26             : namespace PLMD {
      27             : namespace vesselbase {
      28             : 
      29             : class Mean : public FunctionVessel {
      30             : public:
      31             :   static void registerKeywords( Keywords& keys );
      32             :   static void reserveKeyword( Keywords& keys );
      33             :   explicit Mean( const vesselbase::VesselOptions& da );
      34             :   std::string value_descriptor() override;
      35             :   double calcTransform( const double& val, double& dv ) const override;
      36             : };
      37             : 
      38       10502 : PLUMED_REGISTER_VESSEL(Mean,"MEAN")
      39             : 
      40          83 : void Mean::registerKeywords( Keywords& keys ) {
      41          83 :   FunctionVessel::registerKeywords(keys);
      42          83 : }
      43             : 
      44        3473 : void Mean::reserveKeyword( Keywords& keys ) {
      45        6946 :   keys.reserve("vessel","MEAN","take the mean of these variables.");
      46        6946 :   keys.addOutputComponent("mean","MEAN","the mean value. The output component can be referred to elsewhere in the input "
      47             :                           "file by using the label.mean");
      48        3473 : }
      49             : 
      50          83 : Mean::Mean( const vesselbase::VesselOptions& da ) :
      51          83 :   FunctionVessel(da)
      52             : {
      53          83 :   if( getAction()->isPeriodic() ) error("MEAN cannot be used with periodic variables");
      54          83 :   norm=true;   // Makes sure we calculate the average
      55          83 : }
      56             : 
      57          83 : std::string Mean::value_descriptor() {
      58          83 :   return "the mean value";
      59             : }
      60             : 
      61       80103 : double Mean::calcTransform( const double& val, double& dv ) const {
      62       80103 :   dv=1.0; return val;
      63             : }
      64             : 
      65             : }
      66             : }