www.mooseframework.org
Public Member Functions | List of all members
BCUserObject Class Referenceabstract

A base class of user object for calculating the variable values in ghost element according to specific boundary conditions. More...

#include <BCUserObject.h>

Inheritance diagram for BCUserObject:
[legend]

Public Member Functions

 BCUserObject (const InputParameters &parameters)
 
virtual void initialize ()
 
virtual void execute ()
 
virtual void finalize ()
 
virtual std::vector< Real > getGhostCellValue (unsigned int iside, dof_id_type ielem, const std::vector< Real > &uvec1, const RealVectorValue &dwave) const =0
 compute the ghost cell variable values More...
 

Detailed Description

A base class of user object for calculating the variable values in ghost element according to specific boundary conditions.

Notes:

  1. In CFD, a ghost element means a virtual element that is outside a mesh and shares a common boundary face with an element in the mesh.
  2. This user object is used in two places.

    First, it is used in a slope reconstruction user object, in which a slope reconstruction scheme in an element adjacent to a boundary face requires adequate boundary conditions to ensure globally second-order accurate in space.

    Second, it is used in a boundary flux user object, where boundary conditions are required to properly calculate the flux vector and Jacobian matrix across the boundary face.

  3. Derived classes have to override getGhostCellValue.

Definition at line 44 of file BCUserObject.h.

Constructor & Destructor Documentation

◆ BCUserObject()

BCUserObject::BCUserObject ( const InputParameters &  parameters)

Definition at line 20 of file BCUserObject.C.

20 : GeneralUserObject(parameters) {}

Member Function Documentation

◆ execute()

void BCUserObject::execute ( )
virtual

Definition at line 28 of file BCUserObject.C.

29 {
30 }

◆ finalize()

void BCUserObject::finalize ( )
virtual

Definition at line 33 of file BCUserObject.C.

34 {
35 }

◆ getGhostCellValue()

virtual std::vector<Real> BCUserObject::getGhostCellValue ( unsigned int  iside,
dof_id_type  ielem,
const std::vector< Real > &  uvec1,
const RealVectorValue &  dwave 
) const
pure virtual

compute the ghost cell variable values

Parameters
[in]isidelocal index of current side
[in]ielemglobal index of the current element
[in]uvec1vector of variables on the host side
[in]dwavevector of unit normal

◆ initialize()

void BCUserObject::initialize ( )
virtual

Definition at line 23 of file BCUserObject.C.

24 {
25 }

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