Panzer_BC.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_BC_HPP
#define PANZER_BC_HPP
 
#include <string>
#include <iostream>
#include <functional>
#include <cstddef>
#include <vector>
 
#include <unordered_map>
 
#include "Teuchos_RCP.hpp"
 
#include "Panzer_GlobalData.hpp"
 
namespace Teuchos {
  class ParameterList;
}
 
namespace panzer {
 
  class BC;
  class WorksetDescriptor;
 
  void buildBCs(std::vector<panzer::BC>& bcs, const Teuchos::ParameterList& p, const Teuchos::RCP<panzer::GlobalData> global_data);
 
  enum BCType {
    BCT_Dirichlet,
    BCT_Neumann,
    BCT_Interface
  };
 
  class BC {
  public:
    // types supporting hashing
    struct BCHash {
      std::hash<std::string> hash;
      std::size_t operator()(const BC & bc) const
      { return this->hash(bc.elementBlockID() + "_" + bc.sidesetID());}
    };
 
    struct BCEquality {
      bool operator()(const BC & bc1,const BC & bc2) const
      { return bc1.elementBlockID()==bc2.elementBlockID() && bc1.sidesetID()==bc2.sidesetID(); }
    };
    
  public:
 
    BC(std::size_t bc_id,
       BCType bc_type,
       std::string sideset_id,
       std::string element_block_id,
       std::string equation_set_name,
       std::string strategy);
 
    BC(std::size_t bc_id,
       BCType bc_type,
       std::string sideset_id,
       std::string element_block_id,
       std::string equation_set_name,
       std::string strategy,
       const Teuchos::ParameterList& p);
 
    BC(std::size_t bc_id,
       const Teuchos::ParameterList& p);
 
    BC(std::size_t bc_id,
       const Teuchos::ParameterList& p,
       const Teuchos::RCP<panzer::GlobalData> gd);
 
    ~BC();
 
    std::size_t bcID() const;
 
    BCType bcType() const;
 
    std::string sidesetID() const;
 
    std::string elementBlockID() const;
 
    std::string elementBlockID2() const;
 
    std::string equationSetName() const;
 
    std::string equationSetName2() const;
 
    std::string strategy() const;
 
    Teuchos::RCP<const Teuchos::ParameterList> params() const;
 
    Teuchos::RCP<panzer::GlobalData> global_data() const;
 
    Teuchos::RCP<Teuchos::ParameterList> nonconstParams() const;
 
    std::string identifier() const;
 
    void print(std::ostream& os) const;
 
  private:
 
    void validateParameters(Teuchos::ParameterList& p) const;
 
  private:
 
    std::size_t m_bc_id;
 
    BCType m_bc_type;
 
    std::string m_sideset_id;
 
    std::string m_element_block_id;
 
    std::string m_element_block_id2;
 
    std::string m_equation_set_name;
 
    std::string m_equation_set_name2;
 
    std::string m_strategy;
 
    Teuchos::RCP<Teuchos::ParameterList> m_params;
 
    Teuchos::RCP<panzer::GlobalData> m_gd;
  };
 
  std::ostream& 
    operator<<(std::ostream & os, const panzer::BC& bc);
 
  struct LessBC {
    
    bool operator()(const panzer::BC& left, 
        const panzer::BC& right) const
    {
      return left.bcID() < right.bcID();
    }
  };
 
  WorksetDescriptor bcDescriptor(const panzer::BC & bc);
 
}
 
#endif