StaticAnalyser.hpp

/*
 * Copyright (c) 2004-present, The University of Notre Dame. All rights
 * reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the copyright holder nor the names of its
 *    contributors may be used to endorse or promote products derived from
 *    this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * SUPPORT OPEN SCIENCE!  If you use OpenMD or its source code in your
 * research, please cite the following paper when you publish your work:
 *
 * [1] Drisko et al., J. Open Source Softw. 9, 7004 (2024).
 *
 * Good starting points for code and simulation methodology are:
 *
 * [2] Meineke, et al., J. Comp. Chem. 26, 252-271 (2005).
 * [3] Fennell & Gezelter, J. Chem. Phys. 124, 234104 (2006).
 * [4] Sun, Lin & Gezelter, J. Chem. Phys. 128, 234107 (2008).
 * [5] Vardeman, Stocker & Gezelter, J. Chem. Theory Comput. 7, 834 (2011).
 * [6] Kuang & Gezelter, Mol. Phys., 110, 691-701 (2012).
 * [7] Lamichhane, Gezelter & Newman, J. Chem. Phys. 141, 134109 (2014).
 * [8] Bhattarai, Newman & Gezelter, Phys. Rev. B 99, 094106 (2019).
 * [9] Drisko & Gezelter, J. Chem. Theory Comput. 20, 4986-4997 (2024).
 */
 
#ifndef APPLICATIONS_STATICPROPS_STATICANALYSER_HPP
#define APPLICATIONS_STATICPROPS_STATICANALYSER_HPP
 
#include <iostream>
#include <memory>
#include <string>
#include <vector>
 
#include "brains/SimInfo.hpp"
#include "types/AtomType.hpp"
#include "utils/BaseAccumulator.hpp"
 
namespace OpenMD {
 
  class StaticAnalyser {
  public:
    StaticAnalyser(SimInfo* info, const std::string& filename,
                   unsigned int nbins);
 
    virtual ~StaticAnalyser() = default;
    virtual void process()    = 0;
 
    void setOutputName(const std::string& filename) {
      outputFilename_ = filename;
    }
 
    const std::string& getOutputFileName() const { return outputFilename_; }
 
    void setStep(int step) {
      assert(step > 0);
      step_ = step;
    }
 
    int getStep() const { return step_; }
 
    const std::string& getAnalysisType() const { return analysisType_; }
 
    void setAnalysisType(const std::string& type) { analysisType_ = type; }
 
    void setParameterString(const std::string& params) {
      paramString_ = params;
    }
 
  protected:
    struct OutputData {
      std::string title;
      std::string units;
      Utils::DataHandling dataHandling;
      std::vector<std::unique_ptr<Utils::BaseAccumulator>> accumulator;
    };
 
    SimInfo* info_ {nullptr};
    std::string dumpFilename_;
    int step_;
    unsigned int nBins_;
 
    std::string outputFilename_;
    std::string analysisType_;
    std::string paramString_;
 
    std::vector<OutputData> data_;
    std::vector<AtomType*> outputTypes_;
 
    virtual void writeOutput();
  };
}  // namespace OpenMD
 
#endif