FunctionPeriodicBoundary Class Reference

Periodic boundary for calculation periodic BC on domains where the translation is given by functions. More...

#include <FunctionPeriodicBoundary.h>

Inheritance diagram for FunctionPeriodicBoundary:

Public Member Functions
	FunctionPeriodicBoundary (FEProblemBase &subproblem, std::vector< std::string > fn_names)
	Initialize the periodic boundary with three functions. More...
	FunctionPeriodicBoundary (const FunctionPeriodicBoundary &o)
	Copy constructor for creating the periodic boundary and inverse periodic boundary. More...
virtual Point	get_corresponding_pos (const Point &pt) const override
	Get the translation based on point 'pt'. More...
virtual std::unique_ptr< PeriodicBoundaryBase >	clone (TransformationType t) const override
	Required interface, this class must be able to clone itself. More...

Protected Member Functions
void	init ()
	An initialization method to make certain that initialSetup() of a function prior to value() More...

Protected Attributes
unsigned int	_dim
const Function *const	_tr_x
	Pointer to Function for x-component of the boundary. More...
const Function *const	_tr_y
	Pointer to Function for y-component of the boundary. More...
const Function *const	_tr_z
	Pointer to Function for z-component of the boundary. More...

Detailed Description

Periodic boundary for calculation periodic BC on domains where the translation is given by functions.

Definition at line 27 of file FunctionPeriodicBoundary.h.

Constructor & Destructor Documentation

FunctionPeriodicBoundary() [1/2]

FunctionPeriodicBoundary::FunctionPeriodicBoundary	(	FEProblemBase &	subproblem,
		std::vector< std::string >	fn_names
	)

Initialize the periodic boundary with three functions.

Definition at line 21 of file FunctionPeriodicBoundary.C.

  : _dim(fn_names.size()),
    _tr_x(&feproblem.getFunction(fn_names[0])),
    _tr_y(_dim > 1 ? &feproblem.getFunction(fn_names[1]) : NULL),
    _tr_z(_dim > 2 ? &feproblem.getFunction(fn_names[2]) : NULL)
{

  // Make certain the the dimensions agree
  if (_dim != feproblem.mesh().dimension())
    mooseError("Transform function has to have the same dimension as the problem being solved.");

  // Initialize the functions (i.e., call thier initialSetup methods)
  init();
}

FunctionPeriodicBoundary() [2/2]

FunctionPeriodicBoundary::FunctionPeriodicBoundary

(

const FunctionPeriodicBoundary &

o

)

Copy constructor for creating the periodic boundary and inverse periodic boundary.

Parameters

o	- Periodic boundary being copied

Definition at line 37 of file FunctionPeriodicBoundary.C.

  : PeriodicBoundaryBase(o), _dim(o._dim), _tr_x(o._tr_x), _tr_y(o._tr_y), _tr_z(o._tr_z)
{
  // Initialize the functions (i.e., call thier initialSetup methods)
  init();
}

Member Function Documentation

clone()

std::unique_ptr< PeriodicBoundaryBase > FunctionPeriodicBoundary::clone ( TransformationType  t ) const

overridevirtual

Required interface, this class must be able to clone itself.

Definition at line 75 of file FunctionPeriodicBoundary.C.

{
  if (t == INVERSE)
    mooseError("No way to automatically clone() an inverse FunctionPeriodicBoundary object");

  return std::make_unique<FunctionPeriodicBoundary>(*this);
}

get_corresponding_pos()

Point FunctionPeriodicBoundary::get_corresponding_pos ( const Point &  pt ) const

overridevirtual

Get the translation based on point 'pt'.

Parameters

pt	- point on the 'source' boundary

Returns

point on the paired boundary

Definition at line 45 of file FunctionPeriodicBoundary.C.

{
  // Force thread-safe evaluation of what could be ParsedFunctions.
  Threads::spin_mutex::scoped_lock lock(parsed_function_mutex);

  Real t = 0.;
  Point p;
  switch (_dim)
  {
    case 1:
      return Point(_tr_x->value(t, pt));

    case 2:
      mooseAssert(_tr_y, "Must provide a function to map y in 2D.");
      return Point(_tr_x->value(t, pt), _tr_y->value(t, pt));

    case 3:
      mooseAssert(_tr_y, "Must provide a function to map y in 2D.");
      mooseAssert(_tr_z, "Must provide a function to map z in 3D.");
      return Point(_tr_x->value(t, pt), _tr_y->value(t, pt), _tr_z->value(t, pt));

    default:
      mooseError("Unsupported dimension");
      break;
  }

  return pt;
}

init()

void FunctionPeriodicBoundary::init ( )

protected

An initialization method to make certain that initialSetup() of a function prior to value()

Definition at line 84 of file FunctionPeriodicBoundary.C.

Referenced by FunctionPeriodicBoundary().

{
  switch (_dim)
  {
    case 1:
      const_cast<Function *>(_tr_x)->initialSetup();
      break;
    case 2:
      const_cast<Function *>(_tr_x)->initialSetup();
      const_cast<Function *>(_tr_y)->initialSetup();
      break;
    case 3:
      const_cast<Function *>(_tr_x)->initialSetup();
      const_cast<Function *>(_tr_y)->initialSetup();
      const_cast<Function *>(_tr_z)->initialSetup();
      break;
    default:
      mooseError("Unsupported dimension");
      break;
  }
}

Member Data Documentation

_dim

unsigned int FunctionPeriodicBoundary::_dim

protected

Definition at line 56 of file FunctionPeriodicBoundary.h.

Referenced by FunctionPeriodicBoundary(), get_corresponding_pos(), and init().

_tr_x

const Function* const FunctionPeriodicBoundary::_tr_x

protected

Pointer to Function for x-component of the boundary.

Definition at line 59 of file FunctionPeriodicBoundary.h.

Referenced by get_corresponding_pos(), and init().

_tr_y

const Function* const FunctionPeriodicBoundary::_tr_y

protected

Pointer to Function for y-component of the boundary.

Definition at line 62 of file FunctionPeriodicBoundary.h.

Referenced by get_corresponding_pos(), and init().

_tr_z

const Function* const FunctionPeriodicBoundary::_tr_z

protected

Pointer to Function for z-component of the boundary.

Definition at line 65 of file FunctionPeriodicBoundary.h.

Referenced by get_corresponding_pos(), and init().

---

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

• include/bcs/FunctionPeriodicBoundary.h
• src/bcs/FunctionPeriodicBoundary.C