AbaqusUtils Class Reference

Utility class to interface between the object oriented MOOSE app structure and global Abaqus utility functions. More...

#include <AbaqusUtils.h>

Static Public Member Functions
static void	setInputFile (const std::string &input_file)
	Global storage for the simulation output directory, this will be set by any Abaqus class. More...
static std::string	getOutputDir ()
static std::string	getJobName ()
static void	setCommunicator (const libMesh::Parallel::Communicator *communicator)
	Global storage for the MPI communicator, this will be set by any Abaqus class. More...
static const libMesh::Parallel::Communicator *	getCommunicator ()
template<typename T >
static std::map< int, std::vector< T > >::iterator	getSMAIterator (std::map< int, std::vector< T >> &array, int id, const std::string &function)
	get data vector iterator with error checking More...
template<typename T >
static std::map< int, std::vector< T > > &	getSMAThreadArray (std::vector< std::map< int, std::vector< T >>> &local_array, const std::string &function)
	get thread local array More...
static void	smaInitialize ()
	thread storage initialization More...
static void	mutexInit (std::size_t n)
	Mutex API. More...
static void	mutexLock (std::size_t n)
static void	mutexUnlock (std::size_t n)

Static Public Attributes
static std::map< int, std::vector< int > >	_sma_int_array
	Shared Memory Arrays. More...
static std::map< int, std::vector< Real > >	_sma_float_array
static std::vector< std::map< int, std::vector< int > > >	_sma_local_int_array
static std::vector< std::map< int, std::vector< Real > > >	_sma_local_float_array

Static Private Attributes
static std::array< std::unique_ptr< Threads::spin_mutex >, 101 >	_mutex = {{nullptr}}
static std::string	_output_dir = ""
static std::string	_job_name = ""
static const libMesh::Parallel::Communicator *	_communicator = nullptr

Detailed Description

Utility class to interface between the object oriented MOOSE app structure and global Abaqus utility functions.

The class encapsulates static members for intermediate data storage.

Definition at line 19 of file AbaqusUtils.h.

Member Function Documentation

getCommunicator()

static const libMesh::Parallel::Communicator* AbaqusUtils::getCommunicator ( )

inlinestatic

Definition at line 35 of file AbaqusUtils.h.

Referenced by get_communicator(), getnumcpus_(), and getrank_().

{ return _communicator; }

getJobName()

static std::string AbaqusUtils::getJobName ( )

inlinestatic

Definition at line 28 of file AbaqusUtils.h.

Referenced by getjobname_().

{ return _job_name; }

getOutputDir()

static std::string AbaqusUtils::getOutputDir ( )

inlinestatic

Definition at line 27 of file AbaqusUtils.h.

Referenced by getoutdir_().

{ return _output_dir; }

getSMAIterator()

template<typename T >

std::map< int, std::vector< T > >::iterator AbaqusUtils::getSMAIterator ( std::map< int, std::vector< T >> &  array, int  id, const std::string &  function  )

static

get data vector iterator with error checking

Definition at line 72 of file AbaqusUtils.h.

Referenced by SMAFloatArrayAccess(), SMAFloatArrayDelete(), SMAFloatArraySize(), SMAIntArrayAccess(), SMAIntArrayDelete(), SMAIntArraySize(), SMALocalFloatArrayAccess(), SMALocalFloatArrayDelete(), SMALocalFloatArraySize(), SMALocalIntArrayAccess(), SMALocalIntArrayDelete(), and SMALocalIntArraySize().

{
  auto it = array.find(id);
  if (it == array.end())
    mooseError("Invalid id ", id, " in ", function, ".");
  return it;
}

getSMAThreadArray()

template<typename T >

std::map< int, std::vector< T > > & AbaqusUtils::getSMAThreadArray ( std::vector< std::map< int, std::vector< T >>> &  local_array, const std::string &  function  )

static

get thread local array

Definition at line 84 of file AbaqusUtils.h.

Referenced by SMALocalFloatArrayAccess(), SMALocalFloatArrayCreate(), SMALocalFloatArrayDelete(), SMALocalFloatArraySize(), SMALocalIntArrayAccess(), SMALocalIntArrayCreate(), SMALocalIntArrayDelete(), and SMALocalIntArraySize().

{
  ParallelUniqueId puid;
  if (puid.id >= local_array.size())
    mooseError("SMA storage not properly initialized in ", function, ".");
  return local_array[puid.id];
}

mutexInit()

void AbaqusUtils::mutexInit ( std::size_t  n )

static

Mutex API.

Definition at line 358 of file AbaqusUtils.C.

Referenced by MutexInit().

{
  // Guard the initialization with a double checked lock
  if (!_mutex[n])
  {
    Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
    if (!_mutex[n])
      _mutex[n] = std::make_unique<Threads::spin_mutex>();
  }
}

mutexLock()

void AbaqusUtils::mutexLock ( std::size_t  n )

static

Definition at line 370 of file AbaqusUtils.C.

Referenced by MutexLock().

{
  if (n >= _mutex.size() || !_mutex[n])
    mooseError("Invalid or uninitialized mutex ", n);
  _mutex[n]->lock();
}

mutexUnlock()

void AbaqusUtils::mutexUnlock ( std::size_t  n )

static

Definition at line 378 of file AbaqusUtils.C.

Referenced by MutexUnlock().

{
  if (n >= _mutex.size() || !_mutex[n])
    mooseError("Invalid or uninitialized mutex ", n);
  _mutex[n]->unlock();
}

setCommunicator()

void AbaqusUtils::setCommunicator ( const libMesh::Parallel::Communicator *  communicator )

static

Global storage for the MPI communicator, this will be set by any Abaqus class.

MOOSE will throw a warning if multiple objects try to set this to different values.

Definition at line 19 of file AbaqusUtils.C.

Referenced by AbaqusUExternalDB::AbaqusUExternalDB().

{
  if (_communicator != nullptr && communicator != _communicator)
    mooseWarning("Conflicting MPI communicators specified in Abaqus compatibility objects. Are you "
                 "running a multiapps simulation?");

  _communicator = communicator;
}

setInputFile()

void AbaqusUtils::setInputFile ( const std::string &  input_file )

static

Global storage for the simulation output directory, this will be set by any Abaqus class.

MOOSE will throw a warning if multiple objects try to set this to different values.

Definition at line 70 of file AbaqusUtils.C.

Referenced by AbaqusUExternalDB::AbaqusUExternalDB().

{
  auto split = MooseUtils::splitFileName(input_file);
  auto output_dir = split.first;
  auto job_name = MooseUtils::stripExtension(split.second);

  if (!_output_dir.empty() && output_dir != _output_dir)
    mooseWarning("Conflicting output directories specified in Abaqus compatibility objects: ",
                 output_dir,
                 " != ",
                 _output_dir,
                 ". Are you running a multiapps simulation?");

  if (!_job_name.empty() && job_name != _job_name)
    mooseWarning("Conflicting job names specified in Abaqus compatibility objects: ",
                 job_name,
                 " != ",
                 _job_name,
                 ". Are you running a multiapps simulation?");

  _output_dir = output_dir;
  _job_name = job_name;
}

smaInitialize()

void AbaqusUtils::smaInitialize ( )

static

thread storage initialization

Definition at line 188 of file AbaqusUtils.C.

Referenced by SMALocalFloatArrayCreate(), and SMALocalIntArrayCreate().

{
  static bool initialized = false;

  // Guard the initialization with a double checked lock
  if (!initialized)
  {
    Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
    if (!initialized)
    {
      const auto n = getnumthreads_();
      _sma_local_int_array.resize(n);
      _sma_local_float_array.resize(n);
      initialized = true;
    }
  }
}

Member Data Documentation

_communicator

const libMesh::Parallel::Communicator * AbaqusUtils::_communicator = nullptr

staticprivate

Definition at line 67 of file AbaqusUtils.h.

Referenced by getCommunicator(), and setCommunicator().

_job_name

std::string AbaqusUtils::_job_name = ""

staticprivate

Definition at line 66 of file AbaqusUtils.h.

Referenced by getJobName(), and setInputFile().

_mutex

std::array< std::unique_ptr< Threads::spin_mutex >, 101 > AbaqusUtils::_mutex = {{nullptr}}

staticprivate

Definition at line 64 of file AbaqusUtils.h.

Referenced by mutexInit(), mutexLock(), and mutexUnlock().

_output_dir

std::string AbaqusUtils::_output_dir = ""

staticprivate

Definition at line 65 of file AbaqusUtils.h.

Referenced by getOutputDir(), and setInputFile().

_sma_float_array

std::map< int, std::vector< Real > > AbaqusUtils::_sma_float_array

static

Definition at line 53 of file AbaqusUtils.h.

Referenced by SMAFloatArrayAccess(), SMAFloatArrayCreate(), SMAFloatArrayDelete(), and SMAFloatArraySize().

_sma_int_array

std::map< int, std::vector< int > > AbaqusUtils::_sma_int_array

static

Shared Memory Arrays.

Definition at line 52 of file AbaqusUtils.h.

Referenced by SMAIntArrayAccess(), SMAIntArrayCreate(), SMAIntArrayDelete(), and SMAIntArraySize().

_sma_local_float_array

std::vector< std::map< int, std::vector< Real > > > AbaqusUtils::_sma_local_float_array

static

Definition at line 55 of file AbaqusUtils.h.

Referenced by smaInitialize(), SMALocalFloatArrayAccess(), SMALocalFloatArrayCreate(), SMALocalFloatArrayDelete(), and SMALocalFloatArraySize().

_sma_local_int_array

std::vector< std::map< int, std::vector< int > > > AbaqusUtils::_sma_local_int_array

static

Definition at line 54 of file AbaqusUtils.h.

Referenced by smaInitialize(), SMALocalIntArrayAccess(), SMALocalIntArrayCreate(), SMALocalIntArrayDelete(), and SMALocalIntArraySize().

---

The documentation for this class was generated from the following files:

• solid_mechanics/include/utils/AbaqusUtils.h
• solid_mechanics/src/utils/AbaqusUtils.C