www.mooseframework.org
ArrayConstantIC.C
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://www.mooseframework.org
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 "ArrayConstantIC.h"
11 
12 #include "libmesh/point.h"
13 
15 
17 
20 {
22  params.addRequiredParam<RealEigenVector>("value", "The values to be set in IC");
23  params.addClassDescription("Sets constant component values for an array field variable.");
24  return params;
25 }
26 
28  : ArrayInitialCondition(parameters), _value(getParam<RealEigenVector>("value"))
29 {
30  if (_var.count() != _value.size())
31  mooseError("'value' size is inconsistent to the number of components of the array variable");
32 }
33 
35 ArrayConstantIC::value(const Point & /*p*/)
36 {
37  return _value;
38 }
MooseObject::mooseError
void mooseError(Args &&... args) const
Definition: MooseObject.h:141
ArrayConstantIC
Definition: ArrayConstantIC.h:24
ArrayConstantIC::value
virtual RealEigenVector value(const Point &p) override
The value of the variable at a point.
Definition: ArrayConstantIC.C:35
InitialConditionTempl
This is a template class that implements the workhorse compute and computeNodal methods.
Definition: InitialConditionTempl.h:21
ArrayConstantIC::_value
const RealEigenVector _value
Definition: ArrayConstantIC.h:34
InputParameters
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system.
Definition: InputParameters.h:53
MooseVariableBase::count
unsigned int count() const
Get the number of components Note: For standard and vector variables, the number is one.
Definition: MooseVariableBase.h:98
ArrayConstantIC::ArrayConstantIC
ArrayConstantIC(const InputParameters &parameters)
Definition: ArrayConstantIC.C:27
defineLegacyParams
defineLegacyParams(ArrayConstantIC)
InputParameters::addClassDescription
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.
Definition: InputParameters.C:70
InitialConditionTempl::_var
MooseVariableFE< T > & _var
The variable that this initial condition is acting upon.
Definition: InitialConditionTempl.h:132
InitialConditionTempl::validParams
static InputParameters validParams()
Definition: InitialConditionTempl.C:41
ArrayConstantIC.h
registerMooseObject
registerMooseObject("MooseApp", ArrayConstantIC)
ArrayConstantIC::validParams
static InputParameters validParams()
Definition: ArrayConstantIC.C:19
libMesh::RealEigenVector
Eigen::Matrix< Real, Eigen::Dynamic, 1 > RealEigenVector
Definition: MooseTypes.h:133
InputParameters::addRequiredParam
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...
Definition: InputParameters.h:1176