LinearSystemContributionObject.h

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

#pragma once

#include "MooseObject.h"
#include "SetupInterface.h"
#include "FunctionInterface.h"
#include "UserObjectInterface.h"
#include "TransientInterface.h"
#include "PostprocessorInterface.h"
#include "VectorPostprocessorInterface.h"
#include "RandomInterface.h"
#include "Restartable.h"
#include "MeshChangedInterface.h"
#include "TaggingInterface.h"
#include "SystemBase.h"

#include "libmesh/linear_implicit_system.h"

class FEProblemBase;
class MooseMesh;
class SubProblem;
class MooseVariableBase;
class MooseVariableFieldBase;
class InputParameters;

class LinearSystemContributionObject : public MooseObject,
                                       public SetupInterface,
                                       public FunctionInterface,
                                       public UserObjectInterface,
                                       public TransientInterface,
                                       public PostprocessorInterface,
                                       public VectorPostprocessorInterface,
                                       public RandomInterface,
                                       public Restartable,
                                       public MeshChangedInterface,
                                       public TaggingInterface
{
public:
  static InputParameters validParams();

  LinearSystemContributionObject(const InputParameters & parameters);

  virtual void addMatrixContribution() = 0;

  virtual void addRightHandSideContribution() = 0;

  virtual const MooseVariableBase & variable() const = 0;

  void linkTaggedVectorsAndMatrices(const std::set<TagID> & vector_tags,
                                    const std::set<TagID> & matrix_tags);

protected:
  FEProblemBase & _fe_problem;

  SystemBase & _sys;

  libMesh::LinearImplicitSystem & _linear_system;

  const THREAD_ID _tid;

  MooseMesh & _mesh;

  std::vector<NumericVector<Number> *> _vectors;

  std::vector<SparseMatrix<Number> *> _matrices;
};