FXIntegralBaseUserObject< IntegralBaseVariableUserObject > Class Template Reference

This class interacts with a MooseApp through functional expansions. More...

#include <FXIntegralBaseUserObject.h>

Inheritance diagram for FXIntegralBaseUserObject< IntegralBaseVariableUserObject >:

Public Member Functions
	FXIntegralBaseUserObject (const InputParameters &parameters)
const FunctionSeries &	getFunctionSeries () const
	Return a reference to the underlying function series. More...
virtual Real	getValue () const final
virtual void	finalize () final
virtual void	initialize () final
virtual Real	spatialValue (const Point &location) const final
virtual void	threadJoin (const UserObject &sibling) final
Real	operator[] (std::size_t index) const
	Get the value of the coefficient at the corresponding index. More...
const std::vector< std::size_t > &	getCharacteristics () const
	Get a reference to the characteristics array. More...
const std::vector< Real > &	getCoefficients () const
	Get a read-only reference to the vector of coefficients. More...
std::vector< Real > &	getCoefficients ()
	Get a writeable reference to the vector of coefficients. More...
std::string	getCoefficientsTable () const
	Get a formatted string of the coefficients. More...
std::size_t	getSize () const
	Get the size, aka number of coefficients. More...
bool	isCompatibleWith (const MutableCoefficientsInterface &other) const
	Checks to see if another instance is compatible. More...
bool	isSizeEnforced () const
	Returns true if the size of the coefficient array is fixed and enforced. More...
void	enforceSize (bool enforce)
	Toggle whether the size of the coefficient array can be changed. More...
void	importCoefficients (const MutableCoefficientsInterface &other)
	Import the coefficients from another instance. More...
void	resize (std::size_t size, Real fill=0.0, bool fill_out_to_size=true)
	Resize the array, using the value for fill if the new size is larger. More...
void	setCharacteristics (const std::vector< std::size_t > &new_characteristics)
	Sets the characteristics array. More...
void	setCoefficients (const std::vector< Real > &new_coefficients)
	Set the coefficients using a copy operation. More...
void	setCoefficients (std::vector< Real > &&dropin_coefficients)
	Set the coefficients using a move operation (only works with temp objects) More...

Static Public Member Functions
static InputParameters	validParams ()

Protected Member Functions
virtual Real	computeIntegral () final
virtual Point	getCentroid () const =0
	Get the centroid of the evaluated unit. More...
virtual Real	getVolume () const =0
	Get the volume of the evaluated unit. More...
virtual void	coefficientsChanged ()
	Called when the coefficients have been changed. More...
T &	declareRestartableData (const std::string &data_name, Args &&... args)
ManagedValue< T >	declareManagedRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)
const T &	getRestartableData (const std::string &data_name) const
T &	declareRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)
T &	declareRecoverableData (const std::string &data_name, Args &&... args)
T &	declareRestartableDataWithObjectName (const std::string &data_name, const std::string &object_name, Args &&... args)
T &	declareRestartableDataWithObjectNameWithContext (const std::string &data_name, const std::string &object_name, void *context, Args &&... args)
std::string	restartableName (const std::string &data_name) const

Protected Attributes
std::vector< std::vector< Real > >	_coefficient_history
	History of the expansion coefficients for each solve. More...
std::vector< Real >	_coefficient_partials
	Current coefficient partial sums. More...
FunctionSeries &	_function_series
	Reference to the underlying function series. More...
const bool	_keep_history
	Keep the expansion coefficients after each solve. More...
const bool	_print_state
	Flag to prints the state of the zeroth instance in finalize() More...
const Real	_standardized_function_volume
	Volume of the standardized functional space of integration. More...
Real	_volume
	Moose volume of evaluation. More...
std::vector< std::size_t > &	_characteristics
	An array of integer characteristics that can be used to check compatibility. More...
std::vector< Real > &	_coefficients
	The coefficient array. More...
bool	_enforce_size
	Boolean that locks or allows resizing of the coefficient array. More...
const bool	_print_coefficients
	Boolean to flag if the coefficients should be printed when set. More...
MooseApp &	_restartable_app
const std::string	_restartable_system_name
const THREAD_ID	_restartable_tid
const bool	_restartable_read_only

Detailed Description

template<class IntegralBaseVariableUserObject>
class FXIntegralBaseUserObject< IntegralBaseVariableUserObject >

This class interacts with a MooseApp through functional expansions.

It is templated to allow the inheritance of two dual classes that operate in a volume (FXVolumeUserObject) or on a boundary (FXBoundaryFluxUserObject and FXBoundaryValueUserObject)

It uses an instance of FunctionSeries to generate the orthonormal function series required to generate the functional expansion coefficients.

Definition at line 32 of file FXIntegralBaseUserObject.h.

Constructor & Destructor Documentation

FXIntegralBaseUserObject()

template<class IntegralBaseVariableUserObject >

FXIntegralBaseUserObject< IntegralBaseVariableUserObject >::FXIntegralBaseUserObject

(

const InputParameters &

parameters

)

Definition at line 127 of file FXIntegralBaseUserObject.h.

  : IntegralBaseVariableUserObject(parameters),
    MutableCoefficientsInterface(this, parameters),
    _function_series(FunctionSeries::checkAndConvertFunction(
        getFunction("function"), UserObject::getParam<std::string>("_moose_base"), name())),
    _keep_history(UserObject::getParam<bool>("keep_history")),
    _print_state(UserObject::getParam<bool>("print_state")),
    _standardized_function_volume(_function_series.getStandardizedFunctionVolume())
{
  // Size the coefficient arrays
  _coefficient_partials.resize(_function_series.getNumberOfTerms(), 0.0);
  _coefficients.resize(_function_series.getNumberOfTerms(), 0.0);
  _characteristics = _function_series.getOrders();

  if (!_keep_history)
    _coefficient_history.resize(0);
}

Member Function Documentation

coefficientsChanged()

virtual void MutableCoefficientsInterface::coefficientsChanged ( )

inlineprotectedvirtualinherited

Called when the coefficients have been changed.

Reimplemented in MutableCoefficientsFunctionInterface.

Definition at line 105 of file MutableCoefficientsInterface.h.

Referenced by MutableCoefficientsInterface::importCoefficients(), MutableCoefficientsInterface::resize(), and MutableCoefficientsInterface::setCoefficients().

{};

computeIntegral()

template<class IntegralBaseVariableUserObject >

Real FXIntegralBaseUserObject< IntegralBaseVariableUserObject >::computeIntegral ( )

finalprotectedvirtual

Definition at line 148 of file FXIntegralBaseUserObject.h.

{
  Real sum = 0.0;
  const Point centroid = getCentroid();

  // Check to see if this element/side is within the valid boundaries
  if (!_function_series.isInPhysicalBounds(centroid))
    return 0.0;

  // Loop over the quadrature points
  for (_qp = 0; _qp < _q_point.size(); ++_qp)
  {
    // Get the functional terms for a vectorized approach
    _function_series.setLocation(_q_point[_qp]);
    const std::vector<Real> & term_evaluations = _function_series.getGeneration();

    // Evaluate the functional expansion coefficients at each quadrature point
    const Real local_contribution = computeQpIntegral();
    const Real common_evaluation = local_contribution * _JxW[_qp] * _coord[_qp];
    for (std::size_t c = 0; c < _coefficient_partials.size(); ++c)
      _coefficient_partials[c] += term_evaluations[c] * common_evaluation;

    sum += local_contribution;
  }

  _volume += getVolume();

  return sum;
}

enforceSize()

void MutableCoefficientsInterface::enforceSize ( bool  enforce )

inherited

Toggle whether the size of the coefficient array can be changed.

Definition at line 111 of file MutableCoefficientsInterface.C.

Referenced by FunctionSeries::FunctionSeries(), and MutableCoefficientsFunctionInterface::MutableCoefficientsFunctionInterface().

{
  _enforce_size = enforce;
}

finalize()

template<class IntegralBaseVariableUserObject >

void FXIntegralBaseUserObject< IntegralBaseVariableUserObject >::finalize ( )

finalvirtual

Definition at line 180 of file FXIntegralBaseUserObject.h.

{
  // Sum the coefficient arrays over all processes
  _communicator.sum(_coefficient_partials);
  _communicator.sum(_volume);

  // Normalize the volume of the functional expansion to the FX standard space
  const Real volume_normalization = _standardized_function_volume / _volume;
  for (auto & partial : _coefficient_partials)
    partial *= volume_normalization;

  // We now have the completely evaluated coefficients
  _coefficients = _coefficient_partials;

  // The average value is the same as the zeroth coefficient
  _integral_value = _coefficient_partials[0];

  if (_keep_history)
    _coefficient_history.push_back(_coefficients);

  if (_print_state)
  {
    _function_series.setCoefficients(_coefficients);
    _console << COLOR_YELLOW << _function_series << COLOR_DEFAULT << std::endl;
  }
}

getCentroid()

template<class IntegralBaseVariableUserObject>

virtual Point FXIntegralBaseUserObject< IntegralBaseVariableUserObject >::getCentroid ( ) const

protectedpure virtual

Get the centroid of the evaluated unit.

Implemented in FXBoundaryBaseUserObject, and FXVolumeUserObject.

getCharacteristics()

const std::vector< std::size_t > & MutableCoefficientsInterface::getCharacteristics ( ) const

inherited

Get a reference to the characteristics array.

Definition at line 51 of file MutableCoefficientsInterface.C.

{
  return _characteristics;
}

getCoefficients() [1/2]

const std::vector< Real > & MutableCoefficientsInterface::getCoefficients ( ) const

inherited

Get a read-only reference to the vector of coefficients.

Definition at line 57 of file MutableCoefficientsInterface.C.

{
  return _coefficients;
}

getCoefficients() [2/2]

std::vector< Real > & MutableCoefficientsInterface::getCoefficients ( )

inherited

Get a writeable reference to the vector of coefficients.

Definition at line 63 of file MutableCoefficientsInterface.C.

{
  return _coefficients;
}

getCoefficientsTable()

std::string MutableCoefficientsInterface::getCoefficientsTable ( ) const

inherited

Get a formatted string of the coefficients.

Definition at line 69 of file MutableCoefficientsInterface.C.

{
  std::stringbuf string;
  std::ostream table(&string);

  table << *this;

  return string.str();
}

getFunctionSeries()

template<class IntegralBaseVariableUserObject >

const FunctionSeries & FXIntegralBaseUserObject< IntegralBaseVariableUserObject >::getFunctionSeries

(

)

const

Return a reference to the underlying function series.

Definition at line 209 of file FXIntegralBaseUserObject.h.

{
  return _function_series;
}

getSize()

std::size_t MutableCoefficientsInterface::getSize ( ) const

inherited

Get the size, aka number of coefficients.

Definition at line 80 of file MutableCoefficientsInterface.C.

Referenced by MutableCoefficientsInterface::isCompatibleWith(), and operator<<().

{
  return _coefficients.size();
}

getValue()

template<class IntegralBaseVariableUserObject >

Real FXIntegralBaseUserObject< IntegralBaseVariableUserObject >::getValue ( ) const

finalvirtual

Definition at line 216 of file FXIntegralBaseUserObject.h.

{
  return _integral_value;
}

getVolume()

template<class IntegralBaseVariableUserObject>

virtual Real FXIntegralBaseUserObject< IntegralBaseVariableUserObject >::getVolume ( ) const

protectedpure virtual

Get the volume of the evaluated unit.

Implemented in FXBoundaryBaseUserObject, and FXVolumeUserObject.

importCoefficients()

void MutableCoefficientsInterface::importCoefficients ( const MutableCoefficientsInterface &  other )

inherited

Import the coefficients from another instance.

Definition at line 117 of file MutableCoefficientsInterface.C.

Referenced by MultiAppFXTransfer::execute().

{
  if (!isCompatibleWith(other))
    mooseError("Cannot import coefficients from incompatible MutableCoefficientsInterface");

  _coefficients = other._coefficients;

  if (_print_coefficients)
    _console << *this;

  coefficientsChanged();
}

initialize()

template<class IntegralBaseVariableUserObject >

void FXIntegralBaseUserObject< IntegralBaseVariableUserObject >::initialize ( )

finalvirtual

Definition at line 223 of file FXIntegralBaseUserObject.h.

{
  IntegralBaseVariableUserObject::initialize();

  // Clear the partial sums
  for (auto & partial : _coefficient_partials)
    partial = 0;

  _volume = 0;
}

isCompatibleWith()

bool MutableCoefficientsInterface::isCompatibleWith ( const MutableCoefficientsInterface &  other ) const

inherited

Checks to see if another instance is compatible.

Definition at line 86 of file MutableCoefficientsInterface.C.

Referenced by MultiAppFXTransfer::execute(), and MutableCoefficientsInterface::importCoefficients().

{
  // Check the coefficient sizes if requested
  if ((_enforce_size && other._enforce_size) && getSize() != other.getSize())
    return false;

  // Check the size of the characteristics array
  if (_characteristics.size() != other._characteristics.size())
    return false;

  // Check the values of the characteristics array
  for (std::size_t i = 0; i < _characteristics.size(); ++i)
    if (_characteristics[i] != other._characteristics[i])
      return false;

  return true;
}

isSizeEnforced()

bool MutableCoefficientsInterface::isSizeEnforced ( ) const

inherited

Returns true if the size of the coefficient array is fixed and enforced.

Definition at line 105 of file MutableCoefficientsInterface.C.

{
  return _enforce_size;
}

operator[]()

Real MutableCoefficientsInterface::operator[] ( std::size_t  index ) const

inherited

Get the value of the coefficient at the corresponding index.

Definition at line 45 of file MutableCoefficientsInterface.C.

{
  return _coefficients[index];
}

resize()

void MutableCoefficientsInterface::resize ( std::size_t  size, Real  fill = 0.0, bool  fill_out_to_size = true  )

inherited

Resize the array, using the value for fill if the new size is larger.

Definition at line 131 of file MutableCoefficientsInterface.C.

Referenced by FunctionSeries::FunctionSeries().

{
  if (size != _coefficients.size())
  {
    if (_enforce_size &&
        (size > _coefficients.size() || (size < _coefficients.size() && !fill_out_to_size)))
      mooseError("Cannot resize coefficient array with size enforcement enabled.");

    _coefficients.resize(size, fill);

    if (_print_coefficients)
      _console << *this;

    coefficientsChanged();
  }
}

setCharacteristics()

void MutableCoefficientsInterface::setCharacteristics ( const std::vector< std::size_t > &  new_characteristics )

inherited

Sets the characteristics array.

Definition at line 149 of file MutableCoefficientsInterface.C.

Referenced by FunctionSeries::FunctionSeries().

{
  _characteristics = new_characteristics;
}

setCoefficients() [1/2]

void MutableCoefficientsInterface::setCoefficients ( const std::vector< Real > &  new_coefficients )

inherited

Set the coefficients using a copy operation.

Definition at line 156 of file MutableCoefficientsInterface.C.

Referenced by MutableCoefficientsFunctionInterface::MutableCoefficientsFunctionInterface().

{
  if (_enforce_size && new_coefficients.size() != _coefficients.size())
    mooseError("Cannon assigned a coefficient array with differing size when size enforcement is "
               "enabled.");

  _coefficients = new_coefficients;

  if (_print_coefficients)
    _console << *this;

  coefficientsChanged();
}

setCoefficients() [2/2]

void MutableCoefficientsInterface::setCoefficients ( std::vector< Real > &&  dropin_coefficients )

inherited

Set the coefficients using a move operation (only works with temp objects)

Definition at line 171 of file MutableCoefficientsInterface.C.

{
  if (_enforce_size && dropin_coefficients.size() != _coefficients.size())
    mooseError("Cannon assigned a coefficient array with differing size when size enforcement is "
               "enabled.");

  _coefficients = dropin_coefficients;

  if (_print_coefficients)
    _console << *this;

  coefficientsChanged();
}

spatialValue()

template<class IntegralBaseVariableUserObject >

Real FXIntegralBaseUserObject< IntegralBaseVariableUserObject >::spatialValue ( const Point &  location ) const

finalvirtual

Definition at line 249 of file FXIntegralBaseUserObject.h.

{
  _function_series.setLocation(location);

  return _function_series.expand(_coefficients);
}

threadJoin()

template<class IntegralBaseVariableUserObject >

void FXIntegralBaseUserObject< IntegralBaseVariableUserObject >::threadJoin ( const UserObject &  sibling )

finalvirtual

Definition at line 236 of file FXIntegralBaseUserObject.h.

{
  const FXIntegralBaseUserObject<IntegralBaseVariableUserObject> & sibling =
      static_cast<const FXIntegralBaseUserObject<IntegralBaseVariableUserObject> &>(s);

  for (std::size_t c = 0; c < _coefficient_partials.size(); ++c)
    _coefficient_partials[c] += sibling._coefficient_partials[c];

  _volume += sibling._volume;
}

validParams()

template<class IntegralBaseVariableUserObject >

InputParameters FXIntegralBaseUserObject< IntegralBaseVariableUserObject >::validParams ( )

static

Definition at line 106 of file FXIntegralBaseUserObject.h.

Referenced by FXVolumeUserObject::validParams(), and FXBoundaryBaseUserObject::validParams().

{
  InputParameters params = IntegralBaseVariableUserObject::validParams();
  params += MutableCoefficientsInterface::validParams();

  params.addClassDescription(
      "This UserObject interacts with a MooseApp through functional expansions.");

  params.addRequiredParam<FunctionName>("function",
                                        "The name of the FunctionSeries \"Function\" object with "
                                        "which to generate this functional expansion.");

  params.addParam<bool>(
      "keep_history", false, "Keep the expansion coefficients from previous solves");

  params.addParam<bool>("print_state", false, "Print the state of the zeroth instance each solve");

  return params;
}

Member Data Documentation

_characteristics

std::vector<std::size_t>& MutableCoefficientsInterface::_characteristics

protectedinherited

An array of integer characteristics that can be used to check compatibility.

Definition at line 105 of file MutableCoefficientsInterface.h.

Referenced by FXIntegralBaseUserObject< ElementIntegralVariableUserObject >::FXIntegralBaseUserObject(), MutableCoefficientsInterface::getCharacteristics(), MutableCoefficientsInterface::isCompatibleWith(), and MutableCoefficientsInterface::setCharacteristics().

_coefficient_history

template<class IntegralBaseVariableUserObject>

std::vector<std::vector<Real> > FXIntegralBaseUserObject< IntegralBaseVariableUserObject >::_coefficient_history

protected

History of the expansion coefficients for each solve.

Definition at line 83 of file FXIntegralBaseUserObject.h.

Referenced by FXIntegralBaseUserObject< ElementIntegralVariableUserObject >::FXIntegralBaseUserObject().

_coefficient_partials

template<class IntegralBaseVariableUserObject>

std::vector<Real> FXIntegralBaseUserObject< IntegralBaseVariableUserObject >::_coefficient_partials

protected

Current coefficient partial sums.

Definition at line 86 of file FXIntegralBaseUserObject.h.

Referenced by FXIntegralBaseUserObject< ElementIntegralVariableUserObject >::FXIntegralBaseUserObject(), and FXIntegralBaseUserObject< ElementIntegralVariableUserObject >::threadJoin().

_coefficients

std::vector<Real>& MutableCoefficientsInterface::_coefficients

protectedinherited

The coefficient array.

Definition at line 111 of file MutableCoefficientsInterface.h.

Referenced by FunctionSeries::expand(), FXIntegralBaseUserObject< ElementIntegralVariableUserObject >::FXIntegralBaseUserObject(), MutableCoefficientsInterface::getCoefficients(), MutableCoefficientsInterface::getSize(), MutableCoefficientsInterface::importCoefficients(), operator<<(), MutableCoefficientsInterface::operator[](), MutableCoefficientsInterface::resize(), and MutableCoefficientsInterface::setCoefficients().

_enforce_size

bool MutableCoefficientsInterface::_enforce_size

protectedinherited

Boolean that locks or allows resizing of the coefficient array.

Definition at line 114 of file MutableCoefficientsInterface.h.

Referenced by MutableCoefficientsInterface::enforceSize(), MutableCoefficientsInterface::isCompatibleWith(), MutableCoefficientsInterface::isSizeEnforced(), MutableCoefficientsInterface::resize(), and MutableCoefficientsInterface::setCoefficients().

_function_series

template<class IntegralBaseVariableUserObject>

FunctionSeries& FXIntegralBaseUserObject< IntegralBaseVariableUserObject >::_function_series

protected

Reference to the underlying function series.

Definition at line 89 of file FXIntegralBaseUserObject.h.

Referenced by FXIntegralBaseUserObject< ElementIntegralVariableUserObject >::FXIntegralBaseUserObject().

_keep_history

template<class IntegralBaseVariableUserObject>

const bool FXIntegralBaseUserObject< IntegralBaseVariableUserObject >::_keep_history

protected

Keep the expansion coefficients after each solve.

Definition at line 92 of file FXIntegralBaseUserObject.h.

Referenced by FXIntegralBaseUserObject< ElementIntegralVariableUserObject >::FXIntegralBaseUserObject().

_print_coefficients

const bool MutableCoefficientsInterface::_print_coefficients

protectedinherited

Boolean to flag if the coefficients should be printed when set.

Definition at line 117 of file MutableCoefficientsInterface.h.

Referenced by MutableCoefficientsInterface::importCoefficients(), MutableCoefficientsInterface::resize(), and MutableCoefficientsInterface::setCoefficients().

_print_state

template<class IntegralBaseVariableUserObject>

const bool FXIntegralBaseUserObject< IntegralBaseVariableUserObject >::_print_state

protected

Flag to prints the state of the zeroth instance in finalize()

Definition at line 95 of file FXIntegralBaseUserObject.h.

_standardized_function_volume

template<class IntegralBaseVariableUserObject>

const Real FXIntegralBaseUserObject< IntegralBaseVariableUserObject >::_standardized_function_volume

protected

Volume of the standardized functional space of integration.

Definition at line 98 of file FXIntegralBaseUserObject.h.

_volume

template<class IntegralBaseVariableUserObject>

Real FXIntegralBaseUserObject< IntegralBaseVariableUserObject >::_volume

protected

Moose volume of evaluation.

Definition at line 101 of file FXIntegralBaseUserObject.h.

Referenced by FXIntegralBaseUserObject< ElementIntegralVariableUserObject >::threadJoin().

---

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

• functional_expansion_tools/include/userobjects/FXIntegralBaseUserObject.h