Panzer_BCStrategy_Interface_DefaultImpl.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_BCSTRATEGY_INTERFACE_DEFAULT_IMPL_DECL_HPP
#define PANZER_BCSTRATEGY_INTERFACE_DEFAULT_IMPL_DECL_HPP

#include <vector>
#include <string>
#include <tuple>

#include "Teuchos_RCP.hpp"

#include "Panzer_BCStrategy.hpp"
#include "Panzer_GlobalDataAcceptor_DefaultImpl.hpp"
#include "Panzer_Traits.hpp"

#include "Panzer_Traits.hpp"
#include "Phalanx_Evaluator_WithBaseImpl.hpp"
#include "Phalanx_FieldManager.hpp"
#include "Phalanx_MDField.hpp"

#include "Panzer_Evaluator_WithBaseImpl.hpp"

namespace panzer {
  
  template <typename EvalT>
  class BCStrategy_Interface_DefaultImpl : public panzer::BCStrategy<EvalT>,
           public panzer::GlobalDataAcceptorDefaultImpl,
           public panzer::EvaluatorWithBaseImpl<panzer::Traits>
  {
    
  public:    
    
    BCStrategy_Interface_DefaultImpl(const panzer::BC& bc, const Teuchos::RCP<panzer::GlobalData>& global_data);
    
    virtual ~BCStrategy_Interface_DefaultImpl();
    


    virtual void setup(const panzer::PhysicsBlock& side_pb, const Teuchos::ParameterList& user_data) = 0;
      
    virtual void buildAndRegisterEvaluators(PHX::FieldManager<panzer::Traits>& fm,
              const panzer::PhysicsBlock& side_pb,
              const panzer::ClosureModelFactory_TemplateManager<panzer::Traits>& factory,
              const Teuchos::ParameterList& models,
              const Teuchos::ParameterList& user_data) const = 0;

    virtual void 
    buildAndRegisterGatherScatterEvaluators(PHX::FieldManager<panzer::Traits>& fm,
              const panzer::PhysicsBlock& side_pb,
              const panzer::LinearObjFactory<panzer::Traits> & lof,
              const Teuchos::ParameterList& user_data) const;

    virtual void 
    buildAndRegisterScatterEvaluators(PHX::FieldManager<panzer::Traits>& fm,
              const panzer::PhysicsBlock& side_pb,
              const LinearObjFactory<panzer::Traits> & lof,
              const Teuchos::ParameterList& user_data) const;

    virtual void
    buildAndRegisterGatherAndOrientationEvaluators(PHX::FieldManager<panzer::Traits>& fm,
                     const panzer::PhysicsBlock& side_pb,
               const LinearObjFactory<panzer::Traits> & lof,
               const Teuchos::ParameterList& user_data) const;


    virtual void postRegistrationSetup(typename Traits::SetupData d,
               PHX::FieldManager<Traits>& vm) = 0;

    virtual void evaluateFields(typename Traits::EvalData d) = 0;



    virtual void requireDOFGather(const std::string required_dof_name);

    virtual void addResidualContribution(const std::string residual_name,
           const std::string dof_name,
           const std::string flux_name,
           const int integration_order,
           const panzer::PhysicsBlock& side_pb);

    const std::vector<std::tuple<std::string,std::string,std::string,int,Teuchos::RCP<panzer::PureBasis>,Teuchos::RCP<panzer::IntegrationRule> > > getResidualContributionData() const;


    


    const panzer::BC bc() const;


    
  private:



    Teuchos::RCP<panzer::PureBasis> getBasis(const std::string dof_name,
               const panzer::PhysicsBlock& side_pb) const;

    Teuchos::RCP<panzer::IntegrationRule> buildIntegrationRule(const int integration_order,
                     const panzer::PhysicsBlock& side_pb) const;

  private:

    std::vector<std::tuple<std::string,std::string,std::string,int,Teuchos::RCP<panzer::PureBasis>,Teuchos::RCP<panzer::IntegrationRule> > > m_residual_contributions;

    std::vector<std::string> m_required_dof_names;

  };

}

#include "Panzer_BCStrategy_Interface_DefaultImpl_impl.hpp"

#endif