FVInterpolationMethodInterface Class Reference

Helper interface for objects that need access to FVInterpolationMethod instances. More...

#include <FVInterpolationMethodInterface.h>

Inheritance diagram for FVInterpolationMethodInterface:

Public Member Functions
	FVInterpolationMethodInterface (const MooseObject *moose_object)
const FVFaceInterpolationMethod &	getFVFaceInterpolationMethod (const InterpolationMethodName &name) const
const FVAdvectedInterpolationMethod &	getFVAdvectedInterpolationMethod (const InterpolationMethodName &name) const
bool	hasFVInterpolationMethod (const InterpolationMethodName &name) const

Static Public Member Functions
static InputParameters	validParams ()

Protected Attributes
const InputParameters &	_fvim_params
FEProblemBase &	_fvim_feproblem
const THREAD_ID	_fvim_tid

Detailed Description

Helper interface for objects that need access to FVInterpolationMethod instances.

Definition at line 23 of file FVInterpolationMethodInterface.h.

Constructor & Destructor Documentation

FVInterpolationMethodInterface()

FVInterpolationMethodInterface::FVInterpolationMethodInterface

(

const MooseObject *

moose_object

)

Definition at line 22 of file FVInterpolationMethodInterface.C.

  : _fvim_params(moose_object->parameters()),
    _fvim_feproblem(*_fvim_params.getCheckedPointerParam<FEProblemBase *>("_fe_problem_base")),
    _fvim_tid(_fvim_params.have_parameter<THREAD_ID>("_tid") ? _fvim_params.get<THREAD_ID>("_tid")
                                                             : 0)
{
}

Member Function Documentation

getFVAdvectedInterpolationMethod()

const FVAdvectedInterpolationMethod & FVInterpolationMethodInterface::getFVAdvectedInterpolationMethod

(

const InterpolationMethodName &

name

)

const

Definition at line 38 of file FVInterpolationMethodInterface.C.

{
  return _fvim_feproblem.getFVAdvectedInterpolationMethod(name, _fvim_tid);
}

getFVFaceInterpolationMethod()

const FVFaceInterpolationMethod & FVInterpolationMethodInterface::getFVFaceInterpolationMethod

(

const InterpolationMethodName &

name

)

const

Definition at line 31 of file FVInterpolationMethodInterface.C.

{
  return _fvim_feproblem.getFVFaceInterpolationMethod(name, _fvim_tid);
}

hasFVInterpolationMethod()

bool FVInterpolationMethodInterface::hasFVInterpolationMethod

(

const InterpolationMethodName &

name

)

const

Definition at line 45 of file FVInterpolationMethodInterface.C.

{
  return _fvim_feproblem.hasFVInterpolationMethod(name);
}

validParams()

InputParameters FVInterpolationMethodInterface::validParams ( )

static

Definition at line 17 of file FVInterpolationMethodInterface.C.

{
  return emptyInputParameters();
}

Member Data Documentation

_fvim_feproblem

FEProblemBase& FVInterpolationMethodInterface::_fvim_feproblem

protected

Definition at line 40 of file FVInterpolationMethodInterface.h.

Referenced by getFVAdvectedInterpolationMethod(), getFVFaceInterpolationMethod(), and hasFVInterpolationMethod().

_fvim_params

const InputParameters& FVInterpolationMethodInterface::_fvim_params

protected

Definition at line 39 of file FVInterpolationMethodInterface.h.

_fvim_tid

const THREAD_ID FVInterpolationMethodInterface::_fvim_tid

protected

Definition at line 41 of file FVInterpolationMethodInterface.h.

Referenced by getFVAdvectedInterpolationMethod(), and getFVFaceInterpolationMethod().

---

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

• include/interfaces/FVInterpolationMethodInterface.h
• src/interfaces/FVInterpolationMethodInterface.C