SolutionContainer.C

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://mooseframework.inl.gov
//*
//* 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 "SolutionContainer.h"
#include "NonlinearSystemBase.h"

registerMooseObject("StochasticToolsApp", SolutionContainer);

InputParameters
SolutionContainer::validParams()
{
  InputParameters params = SnapshotContainerBase::validParams();
  params.addClassDescription(
      "Class responsible for collecting distributed solution vectors into a container. We append "
      "a new distributed solution vector (containing all variables) at every execution.");
  MooseEnum system_type("nonlinear aux", "nonlinear");
  params.addParam<MooseEnum>(
      "system", system_type, "The system whose solution should be collected.");

  return params;
}

SolutionContainer::SolutionContainer(const InputParameters & parameters)
  : SnapshotContainerBase(parameters), _system_type(getParam<MooseEnum>("system"))
{
  if (isParamSetByUser("nonlinear_system_name") && _system_type == "aux")
    paramError("nonlinear_system_name",
               "This should not be set when 'system_type' is 'aux'. This parameter is only "
               "applicable to nonlinear systems.");
}

std::unique_ptr<NumericVector<Number>>
SolutionContainer::collectSnapshot()
{
  std::unique_ptr<NumericVector<Number>> cloned_solution;

  // Clone the current solution
  if (_system_type == "nonlinear")
    cloned_solution =
        _fe_problem.getNonlinearSystemBase(_nonlinear_system_number).solution().clone();
  else
    cloned_solution = _fe_problem.systemBaseAuxiliary().solution().clone();

  return cloned_solution;
}