Panzer_ExplicitModelEvaluator.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_EXPLICIT_MODEL_EVALUATOR_HPP
#define PANZER_EXPLICIT_MODEL_EVALUATOR_HPP

#include "PanzerDiscFE_config.hpp"

#include "Thyra_ModelEvaluatorDelegatorBase.hpp"
#include "Thyra_BlockedLinearOpBase.hpp"

#include "Panzer_ModelEvaluator.hpp"

#ifdef PANZER_HAVE_EPETRA_STACK
#include "Panzer_ModelEvaluator_Epetra.hpp"
#endif

#include "Panzer_MassMatrixModelEvaluator.hpp"

namespace panzer {

template<typename Scalar>
class ExplicitModelEvaluator
  : public Thyra::ModelEvaluatorDelegatorBase<Scalar>,
    public panzer::MassMatrixModelEvaluator<Scalar> {
public:


  ExplicitModelEvaluator(const Teuchos::RCP<Thyra::ModelEvaluator<Scalar> > & model,
                         bool constantMassMatrix,
                         bool useLumpedMass,
                         bool applyMassInverse=true);


  Thyra::ModelEvaluatorBase::InArgs<Scalar> getNominalValues() const;

  Thyra::ModelEvaluatorBase::InArgs<Scalar> createInArgs() const;

  Thyra::ModelEvaluatorBase::OutArgs<Scalar> createOutArgs() const;

  Teuchos::RCP<panzer::ModelEvaluator<Scalar> > getPanzerUnderlyingModel();

  virtual void applyInverseMassMatrix(const Teuchos::RCP<Thyra::MultiVectorBase<Scalar> > input, const Teuchos::RCP<Thyra::MultiVectorBase<Scalar> > output) const
  {
    Thyra::apply(*invMassMatrix_,Thyra::NOTRANS,*input,output.ptr());
  }

  virtual void applyMassMatrix(const Teuchos::RCP<Thyra::MultiVectorBase<Scalar> > input, const Teuchos::RCP<Thyra::MultiVectorBase<Scalar> > output) const
  {
    Thyra::apply(*mass_,Thyra::NOTRANS,*input,output.ptr());
  }

private: // data members

  void applyDirichletBCs(const Teuchos::RCP<Thyra::VectorBase<Scalar> > & x,
                         const Teuchos::RCP<Thyra::VectorBase<Scalar> > & f) const
  {
    if(panzerModel_!=Teuchos::null)       { panzerModel_->applyDirichletBCs(x,f); return; }
#ifdef PANZER_HAVE_EPETRA_STACK
    if(panzerEpetraModel_!=Teuchos::null) { panzerEpetraModel_->applyDirichletBCs(x,f); return; }
#endif

    TEUCHOS_ASSERT(false);
  }

  void buildInverseMassMatrix(const Thyra::ModelEvaluatorBase::InArgs<Scalar> &inArgs) const;

  void buildArgsPrototypes();


  void evalModelImpl(const Thyra::ModelEvaluatorBase::InArgs<Scalar> &inArgs,
                     const Thyra::ModelEvaluatorBase::OutArgs<Scalar> &outArgs) const;


  void setOneTimeDirichletBeta(double beta,const Thyra::ModelEvaluator<Scalar> & me) const;

  bool constantMassMatrix_;

  bool massLumping_;

  Teuchos::RCP<const panzer::ModelEvaluator<Scalar> > panzerModel_;

#ifdef PANZER_HAVE_EPETRA_STACK
  Teuchos::RCP<const panzer::ModelEvaluator_Epetra> panzerEpetraModel_;
#endif

  mutable Teuchos::RCP<Thyra::LinearOpBase<Scalar> > mass_;
  mutable Teuchos::RCP<const Thyra::LinearOpBase<Scalar> > invMassMatrix_;
  mutable Teuchos::RCP<Thyra::VectorBase<Scalar> > scrap_f_;
  mutable Teuchos::RCP<Thyra::VectorBase<Scalar> > zero_;

  // build prototype in/out args
  Thyra::ModelEvaluatorBase::InArgs<Scalar> prototypeInArgs_;
  Thyra::ModelEvaluatorBase::OutArgs<Scalar> prototypeOutArgs_;

  // hide the default constructor
  ExplicitModelEvaluator();

};

} // end namespace panzer

#endif