Panzer_GatherSolution_Input.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//           Panzer: A partial differential equation assembly
//       engine for strongly coupled complex multiphysics systems
//
// Copyright 2011 NTESS and the Panzer contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER

#ifndef __Panzer_GatherSolution_Input_hpp__
#define __Panzer_GatherSolution_Input_hpp__

#include <vector>
#include <string>

#include "Teuchos_RCP.hpp"
#include "Teuchos_ParameterList.hpp"
#include "Teuchos_ParameterListAcceptorDefaultBase.hpp"

namespace panzer {

// forward declaration
class PureBasis;

class GatherSolution_Input : Teuchos::ParameterListAcceptorDefaultBase {
public:
  GatherSolution_Input();

  void setParameterList(const Teuchos::ParameterList & pl);

  void setParameterList(const Teuchos::RCP<Teuchos::ParameterList> & pl);
  
  Teuchos::RCP<const Teuchos::ParameterList> getValidParameters() const;

  // Accessor functions

  const std::vector<std::string> & getDofNames() const { return  dofNames_; }

  const std::vector<std::string> & getIndexerNames() const { return indexerNames_; }

  Teuchos::RCP<const PureBasis> getBasis() const { return basis_; }

  bool useTimeDerivativeSolutionVector() const { return useTimeDerivSolnVec_; }
  
  std::string getGlobalDataKey() const { return globalDataKey_; }
  
  // tangent
  
  const std::vector<std::vector<std::string> > & getTangentNames() const { return tangentNames_; }

  // jacobian
  
  std::string getSensitivitiesName() const { return sensName_; }

  int getGatherSeedIndex() const { return gatherSeedIndex_; }

  bool firstSensitivitiesAvailable() { return firstSensAvail_; }

  // hessian
  
  bool secondSensitivitiesAvailable() { return secondSensAvail_; }

  std::string getSecondSensitivityDataKeyPrefix() { return secondSensDataKeyPrefix_; }

private:
  GatherSolution_Input(const GatherSolution_Input &); // hide me

  // residual
  std::vector<std::string> dofNames_;   
  std::vector<std::string> indexerNames_;   
  Teuchos::RCP<const PureBasis> basis_;
  bool useTimeDerivSolnVec_;
  std::string globalDataKey_;
  
  // tangent
  std::vector<std::vector<std::string> > tangentNames_;   

  // jacobian
  std::string sensName_;
  int gatherSeedIndex_;
  bool firstSensAvail_;

  // hessian
  bool secondSensAvail_;
  std::string secondSensDataKeyPrefix_;
};

}

#endif