MutableCoefficientsInterface.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 <vector>

#include "InputParameters.h"
#include "MooseTypes.h"
#include "Restartable.h"

class ConsoleStream;

class MutableCoefficientsInterface : public Restartable
{
public:
  static InputParameters validParams();

  MutableCoefficientsInterface(const MooseObject * moose_object,
                               const InputParameters & parameters);

  // Coefficient access
  Real operator[](std::size_t index) const;
  const std::vector<std::size_t> & getCharacteristics() const;
  const std::vector<Real> & getCoefficients() const;
  std::vector<Real> & getCoefficients();
  std::string getCoefficientsTable() const;

  // Current state
  std::size_t getSize() const;
  bool isCompatibleWith(const MutableCoefficientsInterface & other) const;
  bool isSizeEnforced() const;
  void enforceSize(bool enforce);

  // Mutable aspect
  void importCoefficients(const MutableCoefficientsInterface & other);
  void resize(std::size_t size, Real fill = 0.0, bool fill_out_to_size = true);
  void setCharacteristics(const std::vector<std::size_t> & new_characteristics);
  void setCoefficients(const std::vector<Real> & new_coefficients);
  void setCoefficients(std::vector<Real> && dropin_coefficients);

  friend std::ostream & operator<<(std::ostream & stream, const MutableCoefficientsInterface & me);

protected:
  virtual void coefficientsChanged(){};

  std::vector<std::size_t> & _characteristics;

  std::vector<Real> & _coefficients;

  bool _enforce_size;

  const bool _print_coefficients;

private:
  const ConsoleStream & _console;
};