OrientedBoxInterface.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://www.mooseframework.org
//*
//* 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

// MOOSE includes
#include "MooseTypes.h"

#include "libmesh/bounding_box.h" // For destructor
#include "libmesh/vector_value.h"
#include "libmesh/tensor_value.h"

// Forward declarations
class InputParameters;
template <typename T>
InputParameters validParams();

/*
 * An interface class for testing if a point is within a bounding box with arbitrary orientation
 *
 * This constructor does most of the work.
 * The overall strategy is to create a box of the required size which is centered at the origin,
 * with
 * the width along the x axis, the length along the y axis, and the height along the z axis
 *
 * Then create the transformation from real space into this box, which is:
 * a translation from center to the origin, then
 * a rotation from the oriented box frame to this frame
 *
 * see OrientedBoxMarker OrientedSubdomainBoundingBox
 */
class OrientedBoxInterface
{
public:
  static InputParameters validParams();

  OrientedBoxInterface(const InputParameters & parameters);

  virtual ~OrientedBoxInterface() = default;

protected:
  bool containsPoint(const Point & point);

private:
  Point _center;

  std::unique_ptr<RealTensorValue> _rot_matrix;

  std::unique_ptr<BoundingBox> _bounding_box;
};