PODReducedBasisTrainer.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 "libmesh/utility.h"
#include "SurrogateTrainer.h"
#include "MultiApp.h"
#include "MooseTypes.h"
#include "libmesh/parallel.h"
#include "DistributedData.h"

// Forward declarations
namespace libMesh
{
class ReplicatedMesh;
}

typedef StochasticTools::DistributedData<std::shared_ptr<DenseVector<Real>>> DistributedSnapshots;

class PODReducedBasisTrainer : public SurrogateTrainerBase
{
public:
  static InputParameters validParams();

  PODReducedBasisTrainer(const InputParameters & parameters);

  virtual void initialSetup() override;

  virtual void initialize() override{};

  virtual void execute() override;

  virtual void finalize() override;

  void initReducedOperators();

  void addSnapshot(unsigned int var_i,
                   unsigned int glob_i,
                   const std::shared_ptr<DenseVector<Real>> & snapshot);

  void addToReducedOperator(unsigned int base_i,
                            unsigned int tag_i,
                            std::vector<DenseVector<Real>> & residual);

  const std::vector<std::string> & getVarNames() const { return _var_names; }

  const std::vector<std::string> & getTagNames() const { return _tag_names; }

  const std::vector<std::string> & getTagTypes() const { return _tag_types; }

  unsigned int getSnapsSize(unsigned int var_i) const;

  unsigned int getBaseSize(unsigned int var_i) const { return _base[var_i].size(); }

  unsigned int getSumBaseSize() const;

  const DenseVector<Real> & getBasisVector(unsigned int var_i, unsigned int base_i) const;

  const DenseVector<Real> & getBasisVector(unsigned int glob_i) const;

  unsigned int getVariableIndex(unsigned int glob_i) const;

protected:
  void computeCorrelationMatrix();

  void computeEigenDecomposition();

  void computeBasisVectors();

  void printEigenvalues();

  std::vector<std::string> & _var_names;

  std::vector<Real> _error_res;

  std::vector<std::string> & _tag_names;

  std::vector<std::string> & _tag_types;

  std::vector<DistributedSnapshots> _snapshots;

  std::vector<DenseMatrix<Real>> _corr_mx;

  std::vector<DenseVector<Real>> _eigenvalues;

  std::vector<DenseMatrix<Real>> _eigenvectors;

  std::vector<std::vector<DenseVector<Real>>> & _base;

  std::vector<DenseMatrix<Real>> & _red_operators;

  bool _base_completed;

  bool _empty_operators;

private:
  unsigned int determineNumberOfModes(Real error, const std::vector<Real> & inp_vec) const;

  void receiveObjects(
      ReplicatedMesh & mesh,
      std::unordered_map<unsigned int, std::vector<std::shared_ptr<DenseVector<Real>>>> &
          received_vectors,
      std::unordered_map<unsigned int, std::vector<std::shared_ptr<DenseVector<Real>>>> &
          local_vectors,
      processor_id_type /*pid*/,
      const std::vector<
          std::tuple<unsigned int, unsigned int, std::shared_ptr<DenseVector<Real>>>> & vectors);
};