SideSetsGeneratorBase.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://mooseframework.inl.gov
//*
//* All rights reserved, see COPYRIGHT for full restrictions
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
//*
//* Licensed under LGPL 2.1, please see LICENSE for details
//* https://www.gnu.org/licenses/lgpl-2.1.html

#pragma once

#include "MeshGenerator.h"
#include "libmesh/fe_base.h"

// libMesh forward declarations
namespace libMesh
{
class QGauss;
class Elem;
}

/*
 * Base class for mesh generators that add sidesets to the mesh
 */
class SideSetsGeneratorBase : public MeshGenerator
{
public:
  static InputParameters validParams();

  SideSetsGeneratorBase(const InputParameters & parameters);
  virtual ~SideSetsGeneratorBase(); // dtor required for unique_ptr with forward declarations

protected:
  void setup(MeshBase & mesh);

  void finalize();

  void
  flood(const Elem * elem, const Point & normal, const boundary_id_type & side_id, MeshBase & mesh);

  bool normalsWithinTol(const Point & normal_1, const Point & normal_2, const Real & tol) const;

  bool elementSubdomainIdInList(const Elem * const elem,
                                const std::vector<subdomain_id_type> & subdomain_id_list) const;

  bool elementSideInIncludedBoundaries(const Elem * const elem,
                                       const unsigned int side,
                                       const MeshBase & mesh) const;

  bool elementSideInExcludedBoundaries(const Elem * const elem,
                                       const unsigned int side,
                                       const MeshBase & mesh) const;

  bool elemSideSatisfiesRequirements(const Elem * const elem,
                                     const unsigned int side,
                                     const MeshBase & mesh,
                                     const Point & normal,
                                     const Point & face_normal);

  std::unique_ptr<MeshBase> & _input;

  std::vector<BoundaryName> _boundary_names;

  const bool _fixed_normal;

  const bool _replace;

  const bool _check_included_boundaries;

  const bool _check_excluded_boundaries;

  const bool _check_subdomains;

  const bool _check_neighbor_subdomains;

  std::vector<boundary_id_type> _included_boundary_ids;

  std::vector<boundary_id_type> _excluded_boundary_ids;

  std::vector<subdomain_id_type> _included_subdomain_ids;

  std::vector<subdomain_id_type> _included_neighbor_subdomain_ids;

  const bool _include_only_external_sides;

  bool _using_normal;

  Point _normal;

  const Real _normal_tol;

  std::unique_ptr<libMesh::FEBase> _fe_face;
  std::unique_ptr<libMesh::QGauss> _qface;
  std::map<boundary_id_type, std::set<const Elem *>> _visited;
};