MooseEigenSystem.h

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
 
#pragma once
 
#include "NonlinearSystem.h"
 
// libMesh
#include "libmesh/eigen_system.h"
 
class FEProblemBase;
 
class MooseEigenSystem : public NonlinearSystem
{
public:
  MooseEigenSystem(FEProblemBase & problem, const std::string & name);
  virtual ~MooseEigenSystem();
 
  virtual void addKernel(const std::string & kernel_name,
                         const std::string & name,
                         InputParameters & parameters);
 
  virtual void markEigenVariable(const VariableName & var_name);
 
  enum SYSTEMTAG
  {
    ALL,
    EIGEN
  };
 
  void scaleSystemSolution(SYSTEMTAG tag, Real scaling_factor);
 
  void combineSystemSolution(SYSTEMTAG tag, const std::vector<Real> & coefficients);
 
  void initSystemSolution(SYSTEMTAG tag, Real v);
  void initSystemSolutionOld(SYSTEMTAG tag, Real v);
 
  void eigenKernelOnOld();
  void eigenKernelOnCurrent();
 
  void buildSystemDoFIndices(SYSTEMTAG tag = ALL);
 
  bool activeOnOld();
 
  const std::set<VariableName> & getEigenVariableNames() const { return _eigen_var_names; }
 
  bool containsEigenKernel() const;
 
protected:
  std::set<VariableName> _eigen_var_names;
  bool _all_eigen_vars;
  std::set<dof_id_type> _eigen_var_indices;
 
  bool _active_on_old;
 
  unsigned int _eigen_kernel_counter;
};