UserObject.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 "UserObjectBase.h"
 
#include "libmesh/parallel.h"
 
class UserObject : public UserObjectBase
{
public:
  static InputParameters validParams();
 
  UserObject(const InputParameters & params);
 
  virtual void execute() = 0;
 
  virtual Real spatialValue(const Point & /*p*/) const
  {
    mooseError(name(), " does not satisfy the Spatial UserObject interface!");
  }
 
  virtual const std::vector<Point> spatialPoints() const
  {
    mooseError("Spatial UserObject interface is not satisfied; spatialPoints() must be overridden");
  }
 
  virtual void threadJoin(const UserObject & uo) = 0;
 
  void setPrimaryThreadCopy(UserObject * primary);
 
  UserObject * primaryThreadCopy() { return _primary_thread_copy; }
 
protected:
  const Moose::CoordinateSystemType & _coord_sys;
 
private:
  UserObject * _primary_thread_copy = nullptr;
};