FunctionPeriodicBoundary Class Reference

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

#include <FunctionPeriodicBoundary.h>

Inheritance diagram for FunctionPeriodicBoundary:

Public Types
enum	TransformationType

Public Member Functions
	FunctionPeriodicBoundary (FEProblemBase &subproblem, const std::vector< std::string > &fn_names, const std::vector< std::string > &inv_fn_names)
	Initialize the periodic with the functions and inverse functions, one for each dimension needed. More...
	FunctionPeriodicBoundary (const FunctionPeriodicBoundary &o, TransformationType t=FORWARD)
	Copy constructor for creating the periodic boundary and inverse periodic boundary. More...
virtual libMesh::Point	get_corresponding_pos (const libMesh::Point &pt) const override
	Get the translation based on point 'pt'. More...
virtual std::unique_ptr< libMesh::PeriodicBoundaryBase >	clone (TransformationType t) const override
void	set_variable (unsigned int var)
void	merge (const PeriodicBoundaryBase &pb)
bool	is_my_variable (unsigned int var_num) const
bool	has_transformation_matrix () const
const DenseMatrix< Real > &	get_transformation_matrix () const
void	set_transformation_matrix (const DenseMatrix< Real > &matrix)
const std::set< unsigned int > &	get_variables () const

Public Attributes
	FORWARD
	INVERSE
boundary_id_type	myboundary
boundary_id_type	pairedboundary

Protected Attributes
std::set< unsigned int >	variables
std::unique_ptr< DenseMatrix< Real > >	_transformation_matrix

Static Private Member Functions
static std::array< const Function *, 3 >	getFunctions (FEProblemBase &problem, const std::vector< std::string > &names)

Private Attributes
const unsigned int	_dim
	The dimension of the problem (says which of _tr and _inv_tr are active) More...
const std::array< const Function *, 3 >	_tr
	Pointers to translation functions in each dimension. More...
const std::array< const Function *, 3 >	_inv_tr
	Pointers to inverse translation functions in each dimension. More...

Detailed Description

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

Definition at line 27 of file FunctionPeriodicBoundary.h.

Constructor & Destructor Documentation

FunctionPeriodicBoundary() [1/2]

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

Initialize the periodic with the functions and inverse functions, one for each dimension needed.

Definition at line 21 of file FunctionPeriodicBoundary.C.

  : libMesh::PeriodicBoundaryBase(),
    _dim(fn_names.size()),
    _tr(getFunctions(feproblem, fn_names)),
    _inv_tr(getFunctions(feproblem, inv_fn_names))
{
  mooseAssert(fn_names.size() == inv_fn_names.size(), "Size mismatch");

  // 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.");
}

FunctionPeriodicBoundary() [2/2]

FunctionPeriodicBoundary::FunctionPeriodicBoundary	(	const FunctionPeriodicBoundary &	o,
		TransformationType	t = FORWARD
	)

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

Parameters

o	- Periodic boundary being copied
t	- Transformation direction

Definition at line 36 of file FunctionPeriodicBoundary.C.

  : libMesh::PeriodicBoundaryBase(o),
    _dim(o._dim),
    _tr(t == INVERSE ? o._inv_tr : o._tr),
    _inv_tr(t == INVERSE ? o._tr : o._inv_tr)
{
  if (t == INVERSE)
    std::swap(myboundary, pairedboundary);
}

Member Function Documentation

clone()

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

overridevirtual

Implements libMesh::PeriodicBoundaryBase.

Definition at line 63 of file FunctionPeriodicBoundary.C.

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

get_corresponding_pos()

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

overridevirtual

Get the translation based on point 'pt'.

Parameters

pt	- point on the 'source' boundary

Returns

point on the paired boundary

Implements libMesh::PeriodicBoundaryBase.

Definition at line 48 of file FunctionPeriodicBoundary.C.

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

  Point p;
  for (const auto i : make_range(_dim))
  {
    mooseAssert(_tr[i], "Function not provided");
    p(i) = _tr[i]->value(0.0, pt);
  }
  return p;
}

getFunctions()

std::array< const Function *, 3 > FunctionPeriodicBoundary::getFunctions ( FEProblemBase &  problem, const std::vector< std::string > &  names  )

staticprivate

Definition at line 69 of file FunctionPeriodicBoundary.C.

{
  std::array<const Function *, 3> functions;
  for (const auto i : index_range(functions))
    if (names.size() > i)
    {
      functions[i] = &problem.getFunction(names[i]);
      const_cast<Function *>(functions[i])->initialSetup();
    }
  return functions;
}

Member Data Documentation

_dim

const unsigned int FunctionPeriodicBoundary::_dim

private

The dimension of the problem (says which of _tr and _inv_tr are active)

Definition at line 60 of file FunctionPeriodicBoundary.h.

Referenced by FunctionPeriodicBoundary(), and get_corresponding_pos().

_inv_tr

const std::array<const Function *, 3> FunctionPeriodicBoundary::_inv_tr

private

Pointers to inverse translation functions in each dimension.

Definition at line 65 of file FunctionPeriodicBoundary.h.

_tr

const std::array<const Function *, 3> FunctionPeriodicBoundary::_tr

private

Pointers to translation functions in each dimension.

Definition at line 63 of file FunctionPeriodicBoundary.h.

Referenced by get_corresponding_pos().

---

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

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