BoundsBase.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 "AuxKernel.h"
class BoundsBase : public AuxKernel
{
public:
  static InputParameters validParams();

  enum BoundType
  {
    UPPER,
    LOWER
  };

  BoundsBase(const InputParameters & parameters);

protected:
  virtual void initialSetup() override final;
  virtual Real computeValue() override final;

  virtual Real getBound() = 0;

  BoundType _type;

  NumericVector<Number> & _bounded_vector;

  MooseVariableFieldBase & _bounded_var;

  NonlinearVariableName _bounded_var_name;

  MooseVariableFE<Real> * _fe_var;

private:
  dof_id_type getDoFIndex() const;
};