ScalarConstantIC.C

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://www.mooseframework.org
//*
//* All rights reserved, see COPYRIGHT for full restrictions
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
//*
//* Licensed under LGPL 2.1, please see LICENSE for details
//* https://www.gnu.org/licenses/lgpl-2.1.html

#include "ScalarConstantIC.h"

registerMooseObject("MooseApp", ScalarConstantIC);

InputParameters
ScalarConstantIC::validParams()
{
  InputParameters params = ScalarInitialCondition::validParams();
  params.addClassDescription(
      "Initalize a scalar variable with a constant value prescribed by an input parameter.");
  params.addRequiredParam<Real>("value", "Initial value of the scalar variable");
  return params;
}

ScalarConstantIC::ScalarConstantIC(const InputParameters & parameters)
  : ScalarInitialCondition(parameters), _value(getParam<Real>("value"))
{
}

Real
ScalarConstantIC::value()
{
  return _value;
}