memorybudget.h

Go to the documentation of this file.

/*
 *            Copyright 2009-2026 The VOTCA Development Team
 *                       (http://www.votca.org)
 *
 *      Licensed under the Apache License, Version 2.0 (the "License")
 *
 * You may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *              http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */
 
#pragma once
#ifndef VOTCA_XTP_MEMORYBUDGET_H
#define VOTCA_XTP_MEMORYBUDGET_H
 
// Standard includes
#include <string>
 
// VOTCA includes
#include <votca/tools/types.h>
 
namespace votca {
namespace xtp {

class MemoryBudget {
 public:
  static void Set(double total_gb, Index concurrent_jobs = 1);
  static void SetConcurrentJobs(Index concurrent_jobs);
  static bool Given() { return total_bytes_ > 0.0; }
  static double DefaultAllowanceBytes() { return 4e9; }

  static double JobBudgetBytes();

  static double AvailableBytes();

  static double ResidentBytes();

  static double PeakResidentBytes();

  static std::string Usage();

  static std::string Describe();
 
 private:
  static double total_bytes_;
  static Index concurrent_jobs_;
};
 
}  // namespace xtp
}  // namespace votca
 
#endif  // VOTCA_XTP_MEMORYBUDGET_H