NekScalarValue.h

Go to the documentation of this file.

/********************************************************************/
/*                  SOFTWARE COPYRIGHT NOTIFICATION                 */
/*                             Cardinal                             */
/*                                                                  */
/*                  (c) 2021 UChicago Argonne, LLC                  */
/*                        ALL RIGHTS RESERVED                       */
/*                                                                  */
/*                 Prepared by UChicago Argonne, LLC                */
/*               Under Contract No. DE-AC02-06CH11357               */
/*                With the U. S. Department of Energy               */
/*                                                                  */
/*             Prepared by Battelle Energy Alliance, LLC            */
/*               Under Contract No. DE-AC07-05ID14517               */
/*                With the U. S. Department of Energy               */
/*                                                                  */
/*                 See LICENSE for full restrictions                */
/********************************************************************/

#pragma once

#include "GeneralUserObject.h"

class NekScalarValue : public GeneralUserObject
{
public:
  static InputParameters validParams();

  NekScalarValue(const InputParameters & parameters);

  virtual void execute() override {}

  virtual void initialize() override {}
  virtual void finalize() override {}

  virtual void setValue();

  Real getValue() const;

  virtual unsigned int usrwrkSlot() const { return _usrwrk_slot; }

  virtual void setCounter(const unsigned int & counter) { _counter = counter; }

  virtual const unsigned int & counter() const { return _counter; }

protected:
  const Real & _value;

  const Real & _scaling;

  unsigned int _usrwrk_slot;

  unsigned int _counter;
};