https://mooseframework.inl.gov
Loading...
Searching...
No Matches
FVConstantIC.C
Go to the documentation of this file.
1//* This file is part of the MOOSE framework
2//* https://mooseframework.inl.gov
3//*
4//* All rights reserved, see COPYRIGHT for full restrictions
5//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
6//*
7//* Licensed under LGPL 2.1, please see LICENSE for details
8//* https://www.gnu.org/licenses/lgpl-2.1.html
9
10#include "FVConstantIC.h"
11#include "libmesh/point.h"
12
14
17{
19 params.addRequiredParam<Real>("value", "The value to be set in IC");
20 params.addClassDescription("Sets a constant field value.");
21 return params;
22}
23
25 : FVInitialCondition(parameters), _value(getParam<Real>("value"))
26{
27}
28
29Real
30FVConstantIC::value(const Point & /*p*/)
31{
32 return _value;
33}
registerMooseObject("MooseApp", FVConstantIC)
FVConstantIC just returns a constant value for a finite volume variable.
virtual Real value(const Point &p) override
The value of the variable at a point.
FVConstantIC(const InputParameters &parameters)
const Real _value
static InputParameters validParams()
This is a template class that implements the workhorse compute and computeNodal methods.
static InputParameters validParams()
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system.
void addRequiredParam(const std::string &name, const std::string &doc_string)
This method adds a parameter and documentation string to the InputParameters object that will be extr...
void addClassDescription(const std::string &doc_string)
This method adds a description of the class that will be displayed in the input file syntax dump.