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 "GeneralUserObject.h"
      13             : #include "MooseMesh.h"
      14             : 
      15             : class NonlinearSystemBase;
      16             : 
      17             : /**
      18             :  * Renormalization of a vector variable (i.e. a set of variables comprising a vector)
      19             :  */
      20             : class PointwiseRenormalizeVector : public GeneralUserObject
      21             : {
      22             : public:
      23             :   static InputParameters validParams();
      24             : 
      25             :   PointwiseRenormalizeVector(const InputParameters & parameters);
      26             : 
      27             :   void initialize() override;
      28             :   void execute() override;
      29             :   void finalize() override;
      30             : 
      31             :   // only needed for ElementUserObjects and NodalUseroObjects
      32           0 :   void threadJoin(const UserObject &) override {}
      33             : 
      34             : protected:
      35             :   /// reference to the mesh
      36             :   MooseMesh & _mesh;
      37             : 
      38             :   /// names of the variables to renormalize
      39             :   const std::vector<VariableName> & _var_names;
      40             : 
      41             :   // internal ID numbers of the variables to renormalize
      42             :   std::vector<unsigned int> _var_numbers;
      43             : 
      44             :   /// desired norm
      45             :   const Real _target_norm;
      46             : };