FunctionalBasisInterface.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 "MooseEnum.h"
#include "MooseError.h"
#include "MooseTypes.h"
 
// Shortened typename
class FunctionalBasisInterface;
 
class FunctionalBasisInterface
{
public:
  FunctionalBasisInterface();
  FunctionalBasisInterface(const unsigned int number_of_terms);
 
  Real operator[](std::size_t index) const;
 
  const std::vector<Real> & getAllGeneration();
 
  const std::vector<Real> & getAllExpansion();
 
  std::size_t getNumberOfTerms() const;
 
  Real getGeneration();
 
  Real getGenerationSeriesSum();
 
  Real getExpansion();
 
  Real getExpansionSeriesSum();
 
  virtual const std::vector<Real> & getStandardizedFunctionLimits() const = 0;
 
  virtual Real getStandardizedFunctionVolume() const = 0;
 
  bool isGeneration() const;
 
  bool isExpansion() const;
 
  virtual bool isCacheInvalid() const = 0;
 
  virtual bool isInPhysicalBounds(const Point & point) const = 0;
 
  virtual void setLocation(const Point & point) = 0;
 
  virtual void setOrder(const std::vector<std::size_t> & orders) = 0;
 
  virtual void setPhysicalBounds(const std::vector<Real> & bounds) = 0;
 
  static MooseEnum _domain_options;
 
protected:
  virtual void clearBasisEvaluation(const unsigned int & number_of_terms);
 
  virtual void evaluateGeneration() = 0;
 
  virtual void evaluateExpansion() = 0;
 
  Real load(std::size_t index) const;
 
  void save(std::size_t index, Real value);
 
  unsigned int _number_of_terms;
 
  bool _is_cache_invalid;
 
private:
  std::vector<Real> _basis_evaluation;
 
  bool _is_generation;
};