NumVars.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

// MOOSE includes
#include "NumVars.h"

#include "AuxiliarySystem.h"
#include "NonlinearSystemBase.h"
#include "SubProblem.h"

registerMooseObject("MooseApp", NumVars);

InputParameters
NumVars::validParams()
{
  InputParameters params = GeneralPostprocessor::validParams();

  MooseEnum system_enum("NL AUX ALL", "ALL");
  params.addParam<MooseEnum>("system",
                             system_enum,
                             "The system(s) for which you want to retrieve the number of variables "
                             "(NL, AUX, ALL). Default == ALL");

  params.addClassDescription(
      "Return the number of variables from either the NL, Aux, or both systems.");

  return params;
}

NumVars::NumVars(const InputParameters & parameters)
  : GeneralPostprocessor(parameters),
    _system_enum(parameters.get<MooseEnum>("system").getEnum<SystemEnum>()),
    _system_pointer(nullptr),
    _es_pointer(nullptr)
{
  switch (_system_enum)
  {
    case NL:
      mooseAssert(_subproblem.es().has_system("nl0"), "No Nonlinear System found with name nl0");
      _system_pointer = &_subproblem.es().get_system("nl0");
      break;
    case AUX:
      mooseAssert(_subproblem.es().has_system("aux0"), "No Auxilary System found with name aux0");
      _system_pointer = &_subproblem.es().get_system("aux0");
      break;
    case ALL:
      _es_pointer = &_subproblem.es();
      break;
    default:
      mooseError("Unhandled enum");
  }
}

Real
NumVars::getValue() const
{
  switch (_system_enum)
  {
    case NL:
    case AUX:
      return _system_pointer->n_vars();
    case ALL:
      return _es_pointer->n_vars();
    default:
      return 0;
  }
}