www.mooseframework.org
PorousFlowMaterialBase.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 "PorousFlowMaterialBase.h"
11 #include "Conversion.h"
12 
13 template <>
14 InputParameters
16 {
17  InputParameters params = validParams<PorousFlowMaterial>();
18  params.addRequiredParam<unsigned int>("phase", "The phase number");
19  params.addClassDescription("Base class for PorousFlow materials");
20  return params;
21 }
22 
23 PorousFlowMaterialBase::PorousFlowMaterialBase(const InputParameters & parameters)
24  : DerivativeMaterialInterface<PorousFlowMaterial>(parameters),
25  _phase_num(getParam<unsigned int>("phase")),
26  _phase(Moose::stringify(_phase_num))
27 {
28  if (_phase_num >= _dictator.numPhases())
29  paramError("phase",
30  "The Dictator proclaims that the number of fluid phases is ",
31  _dictator.numPhases(),
32  " while you have foolishly entered ",
33  _phase_num,
34  ". Remember that indexing starts at 0. Be aware that the Dictator does not tolerate "
35  "mistakes.");
36 }
validParams< PorousFlowMaterial >
InputParameters validParams< PorousFlowMaterial >()
Definition: PorousFlowMaterial.C:16
PorousFlowMaterial
PorousFlowMaterial is the base class for all PorousFlow Materials It allows users to specify that the...
Definition: PorousFlowMaterial.h:40
PorousFlowMaterialBase::PorousFlowMaterialBase
PorousFlowMaterialBase(const InputParameters &parameters)
Definition: PorousFlowMaterialBase.C:23
PorousFlowMaterialBase.h
PorousFlowMaterialBase::_phase_num
const unsigned int _phase_num
Phase number of fluid.
Definition: PorousFlowMaterialBase.h:34
validParams< PorousFlowMaterialBase >
InputParameters validParams< PorousFlowMaterialBase >()
Definition: PorousFlowMaterialBase.C:15