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) Sandia Corporation
//
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
// the U.S. Government retains certain rights in this software.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Roger P. Pawlowski (rppawlo@sandia.gov) and
// Eric C. Cyr (eccyr@sandia.gov)
// ***********************************************************************
// @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