https://mooseframework.inl.gov
Public Member Functions | Public Attributes | Friends | List of all members
Moose::ElemPointArg Struct Reference

A structure that is used to evaluate Moose functors at an arbitrary physical point contained within an element. More...

#include <MooseFunctorArguments.h>

Public Member Functions

Point getPoint () const
 
ElemArg makeElem () const
 Make a ElemArg from our data. More...
 

Public Attributes

const libMesh::Elemelem
 
libMesh::Point point
 
bool correct_skewness
 

Friends

bool operator< (const ElemPointArg &l, const ElemPointArg &r)
 friend function that allows this structure to be used as keys in ordered containers like sets and maps More...
 

Detailed Description

A structure that is used to evaluate Moose functors at an arbitrary physical point contained within an element.

Definition at line 53 of file MooseFunctorArguments.h.

Member Function Documentation

◆ getPoint()

Point Moose::ElemPointArg::getPoint ( ) const
inline
Returns
The conceptual physical location of this data structure

Definition at line 62 of file MooseFunctorArguments.h.

62 { return point; }

◆ makeElem()

ElemArg Moose::ElemPointArg::makeElem ( ) const
inline

Make a ElemArg from our data.

Definition at line 77 of file MooseFunctorArguments.h.

Referenced by MooseVariableFV< Real >::evaluate().

77 { return {elem, correct_skewness}; }
const libMesh::Elem * elem

Friends And Related Function Documentation

◆ operator<

bool operator< ( const ElemPointArg l,
const ElemPointArg r 
)
friend

friend function that allows this structure to be used as keys in ordered containers like sets and maps

Definition at line 68 of file MooseFunctorArguments.h.

69  {
70  return std::make_tuple(l.elem, l.point, l.correct_skewness) <
71  std::make_tuple(r.elem, r.point, r.correct_skewness);
72  }

Member Data Documentation

◆ correct_skewness

bool Moose::ElemPointArg::correct_skewness

Definition at line 57 of file MooseFunctorArguments.h.

Referenced by makeElem().

◆ elem

const libMesh::Elem* Moose::ElemPointArg::elem

◆ point

libMesh::Point Moose::ElemPointArg::point

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