Line data    Source code

       1             : //* This file is part of the MOOSE framework
       2             : //* https://mooseframework.inl.gov
       3             : //*
       4             : //* All rights reserved, see COPYRIGHT for full restrictions
       5             : //* https://github.com/idaholab/moose/blob/master/COPYRIGHT
       6             : //*
       7             : //* Licensed under LGPL 2.1, please see LICENSE for details
       8             : //* https://www.gnu.org/licenses/lgpl-2.1.html
       9             : 
      10             : #pragma once
      11             : 
      12             : #include "RelationshipManager.h"
      13             : 
      14             : // MOOSE Forward Declares
      15             : class MaterialData;
      16             : class MaterialPropertyStorage;
      17             : 
      18             : /**
      19             :  * RedistributeProperties is used for its \p redistribute() callback,
      20             :  * which ensures that any stateful properties are restributed to the
      21             :  * same properties to which elements they are associated with are
      22             :  * redistributed.
      23             :  */
      24             : class RedistributeProperties : public RelationshipManager
      25             : {
      26             : public:
      27             :   static InputParameters validParams();
      28             : 
      29             :   RedistributeProperties(const InputParameters & parameters);
      30             : 
      31           0 :   RedistributeProperties(const RedistributeProperties & other) = default;
      32             : 
      33             :   /**
      34             :    * This function doesn't actually add anything to \p
      35             :    * coupled_elements - we solely use the \p redistribute()
      36             :    * override to keep internal data structures up to date.
      37             :    */
      38             :   virtual void operator()(const MeshBase::const_element_iterator & range_begin,
      39             :                           const MeshBase::const_element_iterator & range_end,
      40             :                           processor_id_type p,
      41             :                           map_type & coupled_elements) override;
      42             : 
      43             :   /**
      44             :    * Abstract GhostingFunctor code relies on clone(), which for us is
      45             :    * just a copy construction into a new object.
      46             :    */
      47             :   virtual std::unique_ptr<GhostingFunctor> clone() const override;
      48             : 
      49             :   virtual std::string getInfo() const override;
      50             : 
      51             :   virtual bool operator>=(const RelationshipManager & rhs) const override;
      52             : 
      53             :   virtual void redistribute() override;
      54             : 
      55             :   /**
      56             :    * Pushes the given pair ( \p mat_data , \p mat_props ) onto our
      57             :    * list of \p _materials data to redistribute each time our
      58             :    * underlying mesh is redistributed.
      59             :    */
      60             :   void addMaterialPropertyStorage(MaterialPropertyStorage & mat_props);
      61             : 
      62             : private:
      63             :   std::vector<MaterialPropertyStorage *> _materials;
      64             : };