https://mooseframework.inl.gov
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Private Attributes | List of all members
Moose::Kokkos::Variable Class Reference

The Kokkos variable object that carries the coupled variable and tag information. More...

#include <KokkosVariable.h>

Public Types

using CoupleableKey = ::Moose::PassKey<::Coupleable >
 
using ScalarCoupleableKey = ::Moose::PassKey<::ScalarCoupleable >
 

Public Member Functions

 Variable ()=default
 Default constructor.
 
 Variable (const MooseVariableBase &variable, const TagID tag)
 Constructor Initialize the variable with a MOOSE variable and vector tag ID.
 
 Variable (const MooseVariableBase &variable, const TagName &tag_name=Moose::SOLUTION_TAG)
 Constructor Initialize the variable with a MOOSE variable and vector tag name.
 
void init (const MooseVariableBase &variable, const TagID tag)
 Initialize the variable with a MOOSE variable and vector tag ID.
 
void init (const MooseVariableBase &variable, const TagName &tag_name=Moose::SOLUTION_TAG)
 Initialize the variable with a MOOSE variable and vector tag name.
 
void init (const std::vector< Real3 > &values, CoupleableKey)
 Initialize the variable with default coupled vector values.
 
KOKKOS_FUNCTION bool initialized () const
 Get whether the variable is initialized.
 
KOKKOS_FUNCTION bool coupled () const
 Get whether the variable is coupled.
 
KOKKOS_FUNCTION bool nodal () const
 Get whether the variable is nodal.
 
KOKKOS_FUNCTION bool scalar () const
 Get whether the variable is scalar.
 
KOKKOS_FUNCTION bool dot () const
 Get whether the tag is time derivative.
 
KOKKOS_FUNCTION bool old () const
 Get whether the tag is old/older value.
 
KOKKOS_FUNCTION bool vector () const
 Get whether the variable is vector variable.
 
KOKKOS_FUNCTION unsigned int components () const
 Get the number of components.
 
KOKKOS_FUNCTION TagID tag () const
 Get the vector tag ID.
 
KOKKOS_FUNCTION unsigned int var (unsigned int comp=0) const
 Get the variable number of a component.
 
KOKKOS_FUNCTION unsigned int sys (unsigned int comp=0) const
 Get the system number of a component.
 
KOKKOS_FUNCTION Real value (unsigned int comp=0) const
 Get the default value of a component.
 
KOKKOS_FUNCTION Real3 vectorValue (unsigned int comp=0) const
 Get the default vector value of a component.
 
 Variable (const std::vector< const MooseVariableBase * > &variables, const TagID tag)
 Constructor Initialize the variable with multiple MOOSE variables and vector tag ID.
 
 Variable (const std::vector< MooseVariableBase * > &variables, const TagID tag)
 
 Variable (const std::vector< const MooseVariableFieldBase * > &variables, const TagID tag)
 
 Variable (const std::vector< MooseVariableFieldBase * > &variables, const TagID tag)
 
 Variable (const std::vector< const MooseVariableScalar * > &variables, const TagID tag)
 
 Variable (const std::vector< MooseVariableScalar * > &variables, const TagID tag)
 
 Variable (const std::vector< const MooseVariableBase * > &variables, const TagName &tag_name=Moose::SOLUTION_TAG)
 Constructor Initialize the variable with multiple MOOSE variables and vector tag name.
 
 Variable (const std::vector< MooseVariableBase * > &variables, const TagName &tag_name=Moose::SOLUTION_TAG)
 
 Variable (const std::vector< const MooseVariableFieldBase * > &variables, const TagName &tag_name=Moose::SOLUTION_TAG)
 
 Variable (const std::vector< MooseVariableFieldBase * > &variables, const TagName &tag_name=Moose::SOLUTION_TAG)
 
 Variable (const std::vector< const MooseVariableScalar * > &variables, const TagName &tag_name=Moose::SOLUTION_TAG)
 
 Variable (const std::vector< MooseVariableScalar * > &variables, const TagName &tag_name=Moose::SOLUTION_TAG)
 
void init (const std::vector< const MooseVariableBase * > &variables, const TagID tag)
 Initialize the variable with multiple MOOSE variables and vector tag ID.
 
void init (const std::vector< MooseVariableBase * > &variables, const TagID tag)
 
void init (const std::vector< const MooseVariableFieldBase * > &variables, const TagID tag)
 
void init (const std::vector< MooseVariableFieldBase * > &variables, const TagID tag)
 
void init (const std::vector< const MooseVariableScalar * > &variables, const TagID tag)
 
void init (const std::vector< MooseVariableScalar * > &variables, const TagID tag)
 
void init (const std::vector< const MooseVariableBase * > &variables, const TagName &tag_name=Moose::SOLUTION_TAG)
 Initialize the variable with multiple MOOSE variables and vector tag name.
 
void init (const std::vector< MooseVariableBase * > &variables, const TagName &tag_name=Moose::SOLUTION_TAG)
 
void init (const std::vector< const MooseVariableFieldBase * > &variables, const TagName &tag_name=Moose::SOLUTION_TAG)
 
void init (const std::vector< MooseVariableFieldBase * > &variables, const TagName &tag_name=Moose::SOLUTION_TAG)
 
void init (const std::vector< const MooseVariableScalar * > &variables, const TagName &tag_name=Moose::SOLUTION_TAG)
 
void init (const std::vector< MooseVariableScalar * > &variables, const TagName &tag_name=Moose::SOLUTION_TAG)
 
void init (const std::vector< Real > &values, CoupleableKey)
 Initialize the variable with default coupled values.
 
void init (const std::vector< Real > &values, ScalarCoupleableKey)
 
const MooseVariableBase * mooseVar (unsigned int comp=0)
 Get the MOOSE variable of a component.
 
const MooseVariableFieldBase * mooseFieldVar (unsigned int comp=0)
 
const MooseVariableScalar * mooseScalarVar (unsigned int comp=0)
 

Private Attributes

bool _initialized = false
 Whether the variable is initialized.
 
bool _coupled = false
 Whether the variable is coupled.
 
bool _nodal = false
 Whether the variable is nodal.
 
bool _scalar = false
 Whether the variable is scalar.
 
bool _dot = false
 Whether the tag is time derivative.
 
bool _old = false
 Whether the tag is old/older value.
 
bool _vector = false
 Whether the variable is vector variable.
 
unsigned int _components = 1
 Number of components.
 
TagID _tag = Moose::INVALID_TAG_ID
 Vector tag ID.
 
Array< const MooseVariableBase * > _moose_var
 MOOSE variable of each component.
 
Array< unsigned int > _var
 Variable number of each component.
 
Array< unsigned int > _sys
 System number of each component.
 
Array< Real > _default_value
 Default value of each component when the variable is not coupled.
 
Array< Real3 > _default_vector_value
 Default vector value of each component when the variable is not coupled.
 

Detailed Description

The Kokkos variable object that carries the coupled variable and tag information.

Definition at line 28 of file KokkosVariable.h.

Member Typedef Documentation

◆ CoupleableKey

using Moose::Kokkos::Variable::CoupleableKey = ::Moose::PassKey<::Coupleable>

Definition at line 31 of file KokkosVariable.h.

◆ ScalarCoupleableKey

using Moose::Kokkos::Variable::ScalarCoupleableKey = ::Moose::PassKey<::ScalarCoupleable>

Definition at line 32 of file KokkosVariable.h.

Constructor & Destructor Documentation

◆ Variable() [1/15]

Moose::Kokkos::Variable::Variable ( )
default

Default constructor.

◆ Variable() [2/15]

Moose::Kokkos::Variable::Variable ( const MooseVariableBase &  variable,
const TagID  tag 
)
inline

Constructor Initialize the variable with a MOOSE variable and vector tag ID.

Parameters
variableThe MOOSE variable
tagThe vector tag ID

Definition at line 44 of file KokkosVariable.h.

44{ init(variable, tag); }
Moose::Kokkos::Variable::tag
KOKKOS_FUNCTION TagID tag() const
Get the vector tag ID.
Definition KokkosVariable.h:264
Moose::Kokkos::Variable::init
void init(const MooseVariableBase &variable, const TagID tag)
Initialize the variable with a MOOSE variable and vector tag ID.

◆ Variable() [3/15]

Moose::Kokkos::Variable::Variable ( const MooseVariableBase &  variable,
const TagName &  tag_name = Moose::SOLUTION_TAG 
)
inline

Constructor Initialize the variable with a MOOSE variable and vector tag name.

Parameters
variableThe MOOSE variable
tag_nameThe vector tag name

Definition at line 51 of file KokkosVariable.h.

52 {
53 init(variable, tag_name);
54 }
Moose::Kokkos::Variable::vector
KOKKOS_FUNCTION bool vector() const
Get whether the variable is vector variable.
Definition KokkosVariable.h:254

◆ Variable() [4/15]

Moose::Kokkos::Variable::Variable ( const std::vector< const MooseVariableBase * > &  variables,
const TagID  tag 
)
inline

Constructor Initialize the variable with multiple MOOSE variables and vector tag ID.

Parameters
variablesThe MOOSE variables
tagThe vector tag ID

Definition at line 62 of file KokkosVariable.h.

63 {
64 init(variables, tag);
65 }

◆ Variable() [5/15]

Moose::Kokkos::Variable::Variable ( const std::vector< MooseVariableBase * > &  variables,
const TagID  tag 
)
inline

Definition at line 66 of file KokkosVariable.h.

67 {
68 init(variables, tag);
69 }

◆ Variable() [6/15]

Moose::Kokkos::Variable::Variable ( const std::vector< const MooseVariableFieldBase * > &  variables,
const TagID  tag 
)
inline

Definition at line 70 of file KokkosVariable.h.

71 {
72 init(variables, tag);
73 }

◆ Variable() [7/15]

Moose::Kokkos::Variable::Variable ( const std::vector< MooseVariableFieldBase * > &  variables,
const TagID  tag 
)
inline

Definition at line 74 of file KokkosVariable.h.

75 {
76 init(variables, tag);
77 }

◆ Variable() [8/15]

Moose::Kokkos::Variable::Variable ( const std::vector< const MooseVariableScalar * > &  variables,
const TagID  tag 
)
inline

Definition at line 78 of file KokkosVariable.h.

79 {
80 init(variables, tag);
81 }

◆ Variable() [9/15]

Moose::Kokkos::Variable::Variable ( const std::vector< MooseVariableScalar * > &  variables,
const TagID  tag 
)
inline

Definition at line 82 of file KokkosVariable.h.

83 {
84 init(variables, tag);
85 }

◆ Variable() [10/15]

Moose::Kokkos::Variable::Variable ( const std::vector< const MooseVariableBase * > &  variables,
const TagName &  tag_name = Moose::SOLUTION_TAG 
)
inline

Constructor Initialize the variable with multiple MOOSE variables and vector tag name.

Parameters
variablesThe MOOSE variables
tagThe vector tag ID

Definition at line 94 of file KokkosVariable.h.

96 {
97 init(variables, tag_name);
98 }

◆ Variable() [11/15]

Moose::Kokkos::Variable::Variable ( const std::vector< MooseVariableBase * > &  variables,
const TagName &  tag_name = Moose::SOLUTION_TAG 
)
inline

Definition at line 99 of file KokkosVariable.h.

101 {
102 init(variables, tag_name);
103 }

◆ Variable() [12/15]

Moose::Kokkos::Variable::Variable ( const std::vector< const MooseVariableFieldBase * > &  variables,
const TagName &  tag_name = Moose::SOLUTION_TAG 
)
inline

Definition at line 104 of file KokkosVariable.h.

106 {
107 init(variables, tag_name);
108 }

◆ Variable() [13/15]

Moose::Kokkos::Variable::Variable ( const std::vector< MooseVariableFieldBase * > &  variables,
const TagName &  tag_name = Moose::SOLUTION_TAG 
)
inline

Definition at line 109 of file KokkosVariable.h.

111 {
112 init(variables, tag_name);
113 }

◆ Variable() [14/15]

Moose::Kokkos::Variable::Variable ( const std::vector< const MooseVariableScalar * > &  variables,
const TagName &  tag_name = Moose::SOLUTION_TAG 
)
inline

Definition at line 114 of file KokkosVariable.h.

116 {
117 init(variables, tag_name);
118 }

◆ Variable() [15/15]

Moose::Kokkos::Variable::Variable ( const std::vector< MooseVariableScalar * > &  variables,
const TagName &  tag_name = Moose::SOLUTION_TAG 
)
inline

Definition at line 119 of file KokkosVariable.h.

121 {
122 init(variables, tag_name);
123 }

Member Function Documentation

◆ components()

KOKKOS_FUNCTION unsigned int Moose::Kokkos::Variable::components ( ) const
inline

Get the number of components.

Returns
The number of components

Definition at line 259 of file KokkosVariable.h.

259{ return _components; }
Moose::Kokkos::Variable::_components
unsigned int _components
Number of components.
Definition KokkosVariable.h:332

Referenced by Moose::Kokkos::LinearSystemContributionObject::accumulateTaggedMatrix(), Moose::Kokkos::LinearSystemContributionObject::accumulateTaggedVector(), Moose::Kokkos::LinearFVFluxKernel::operator()(), Moose::Kokkos::LinearFVFluxKernel::operator()(), Moose::Kokkos::LinearFVFluxKernel::operator()(), Moose::Kokkos::LinearFVFluxKernel::operator()(), Moose::Kokkos::LinearFVElementalKernel::operator()(), Moose::Kokkos::LinearFVElementalKernel::operator()(), Moose::Kokkos::VariableGradientTempl< is_ad >::VariableGradientTempl(), and Moose::Kokkos::VariableValueTempl< is_ad >::VariableValueTempl().

◆ coupled()

KOKKOS_FUNCTION bool Moose::Kokkos::Variable::coupled ( ) const
inline

Get whether the variable is coupled.

Returns
Whether the variable is coupled

Definition at line 229 of file KokkosVariable.h.

229{ return _coupled; }
Moose::Kokkos::Variable::_coupled
bool _coupled
Whether the variable is coupled.
Definition KokkosVariable.h:308

Referenced by Moose::Kokkos::VariableValueTempl< is_ad >::operator bool(), Moose::Kokkos::VariableGradientTempl< is_ad >::operator bool(), Moose::Kokkos::VectorVariableValue::operator bool(), Moose::Kokkos::VectorVariableGradient::operator bool(), Moose::Kokkos::VectorVariableCurl::operator bool(), Moose::Kokkos::VectorVariableValue::operator()(), Moose::Kokkos::VectorVariableGradient::operator()(), Moose::Kokkos::VectorVariableCurl::operator()(), Moose::Kokkos::VariableGradientTempl< is_ad >::VariableGradientTempl(), and Moose::Kokkos::VariableValueTempl< is_ad >::VariableValueTempl().

◆ dot()

KOKKOS_FUNCTION bool Moose::Kokkos::Variable::dot ( ) const
inline

Get whether the tag is time derivative.

Returns
Whether the tag is time derivative

Definition at line 244 of file KokkosVariable.h.

244{ return _dot; }
Moose::Kokkos::Variable::_dot
bool _dot
Whether the tag is time derivative.
Definition KokkosVariable.h:320

Referenced by Moose::Kokkos::VariableGradientTempl< is_ad >::VariableGradientTempl(), and Moose::Kokkos::VariableValueTempl< is_ad >::VariableValueTempl().

◆ init() [1/17]

void Moose::Kokkos::Variable::init ( const MooseVariableBase &  variable,
const TagID  tag 
)

Initialize the variable with a MOOSE variable and vector tag ID.

Parameters
variableThe MOOSE variable
tagThe vector tag ID

Referenced by init(), init(), init(), init(), init(), Variable(), Variable(), Variable(), Variable(), Variable(), Variable(), Variable(), Variable(), Variable(), Variable(), Variable(), Variable(), Variable(), and Variable().

◆ init() [2/17]

void Moose::Kokkos::Variable::init ( const MooseVariableBase &  variable,
const TagName &  tag_name = Moose::SOLUTION_TAG 
)

Initialize the variable with a MOOSE variable and vector tag name.

Parameters
variableThe MOOSE variable
tag_nameThe vector tag name

◆ init() [3/17]

void Moose::Kokkos::Variable::init ( const std::vector< const MooseVariableBase * > &  variables,
const TagID  tag 
)

Initialize the variable with multiple MOOSE variables and vector tag ID.

Parameters
variablesThe MOOSE variables
tagThe vector tag ID

◆ init() [4/17]

void Moose::Kokkos::Variable::init ( const std::vector< const MooseVariableBase * > &  variables,
const TagName &  tag_name = Moose::SOLUTION_TAG 
)

Initialize the variable with multiple MOOSE variables and vector tag name.

Parameters
variablesThe MOOSE variables
tag_nameThe vector tag name

◆ init() [5/17]

void Moose::Kokkos::Variable::init ( const std::vector< const MooseVariableFieldBase * > &  variables,
const TagID  tag 
)
inline

Definition at line 148 of file KokkosVariable.h.

149 {
150 init(std::vector<const MooseVariableBase *>(variables.begin(), variables.end()), tag);
151 }

◆ init() [6/17]

void Moose::Kokkos::Variable::init ( const std::vector< const MooseVariableFieldBase * > &  variables,
const TagName &  tag_name = Moose::SOLUTION_TAG 
)

◆ init() [7/17]

void Moose::Kokkos::Variable::init ( const std::vector< const MooseVariableScalar * > &  variables,
const TagID  tag 
)
inline

Definition at line 156 of file KokkosVariable.h.

157 {
158 init(std::vector<const MooseVariableBase *>(variables.begin(), variables.end()), tag);
159 }

◆ init() [8/17]

void Moose::Kokkos::Variable::init ( const std::vector< const MooseVariableScalar * > &  variables,
const TagName &  tag_name = Moose::SOLUTION_TAG 
)

◆ init() [9/17]

void Moose::Kokkos::Variable::init ( const std::vector< MooseVariableBase * > &  variables,
const TagID  tag 
)
inline

Definition at line 144 of file KokkosVariable.h.

145 {
146 init(std::vector<const MooseVariableBase *>(variables.begin(), variables.end()), tag);
147 }

◆ init() [10/17]

void Moose::Kokkos::Variable::init ( const std::vector< MooseVariableBase * > &  variables,
const TagName &  tag_name = Moose::SOLUTION_TAG 
)

◆ init() [11/17]

void Moose::Kokkos::Variable::init ( const std::vector< MooseVariableFieldBase * > &  variables,
const TagID  tag 
)
inline

Definition at line 152 of file KokkosVariable.h.

153 {
154 init(std::vector<const MooseVariableBase *>(variables.begin(), variables.end()), tag);
155 }

◆ init() [12/17]

void Moose::Kokkos::Variable::init ( const std::vector< MooseVariableFieldBase * > &  variables,
const TagName &  tag_name = Moose::SOLUTION_TAG 
)

◆ init() [13/17]

void Moose::Kokkos::Variable::init ( const std::vector< MooseVariableScalar * > &  variables,
const TagID  tag 
)
inline

Definition at line 160 of file KokkosVariable.h.

161 {
162 init(std::vector<const MooseVariableBase *>(variables.begin(), variables.end()), tag);
163 }

◆ init() [14/17]

void Moose::Kokkos::Variable::init ( const std::vector< MooseVariableScalar * > &  variables,
const TagName &  tag_name = Moose::SOLUTION_TAG 
)

◆ init() [15/17]

void Moose::Kokkos::Variable::init ( const std::vector< Real > &  values,
CoupleableKey   
)

Initialize the variable with default coupled values.

Parameters
valuesThe default coupled values

◆ init() [16/17]

void Moose::Kokkos::Variable::init ( const std::vector< Real > &  values,
ScalarCoupleableKey   
)

◆ init() [17/17]

void Moose::Kokkos::Variable::init ( const std::vector< Real3 > &  values,
CoupleableKey   
)

Initialize the variable with default coupled vector values.

Parameters
valuesThe default coupled vector values

◆ initialized()

KOKKOS_FUNCTION bool Moose::Kokkos::Variable::initialized ( ) const
inline

Get whether the variable is initialized.

Returns
Whether the variable is initialized

Definition at line 224 of file KokkosVariable.h.

224{ return _initialized; }
Moose::Kokkos::Variable::_initialized
bool _initialized
Whether the variable is initialized.
Definition KokkosVariable.h:304

Referenced by Moose::Kokkos::checkVariable(), Moose::Kokkos::VectorVariableValue::operator()(), Moose::Kokkos::VectorVariableGradient::operator()(), and Moose::Kokkos::VectorVariableCurl::operator()().

◆ mooseFieldVar()

const MooseVariableFieldBase * Moose::Kokkos::Variable::mooseFieldVar ( unsigned int  comp = 0)
inline

Definition at line 208 of file KokkosVariable.h.

209 {
210 return _moose_var.size() ? dynamic_cast<const MooseVariableFieldBase *>(_moose_var[comp])
211 : nullptr;
212 }
MooseVariableFieldBase
This class provides an interface for common operations on field variables of both FE and FV types wit...
Definition MooseVariableFieldBase.h:30
Moose::Kokkos::ArrayBase::size
KOKKOS_FUNCTION index_type size() const
Get the total array size.
Definition KokkosArray.h:294
Moose::Kokkos::Variable::_moose_var
Array< const MooseVariableBase * > _moose_var
MOOSE variable of each component.
Definition KokkosVariable.h:340

◆ mooseScalarVar()

const MooseVariableScalar * Moose::Kokkos::Variable::mooseScalarVar ( unsigned int  comp = 0)
inline

Definition at line 213 of file KokkosVariable.h.

214 {
215 return _moose_var.size() ? dynamic_cast<const MooseVariableScalar *>(_moose_var[comp])
216 : nullptr;
217 }
MooseVariableScalar
Class for scalar variables (they are different).
Definition MooseVariableScalar.h:30

◆ mooseVar()

const MooseVariableBase * Moose::Kokkos::Variable::mooseVar ( unsigned int  comp = 0)
inline

Get the MOOSE variable of a component.

Parameters
compThe variable component
Returns
The MOOSE variable

Definition at line 204 of file KokkosVariable.h.

205 {
206 return _moose_var.size() ? _moose_var[comp] : nullptr;
207 }

Referenced by Moose::Kokkos::VariableGradientTempl< is_ad >::VariableGradientTempl(), and Moose::Kokkos::VariableValueTempl< is_ad >::VariableValueTempl().

◆ nodal()

KOKKOS_FUNCTION bool Moose::Kokkos::Variable::nodal ( ) const
inline

Get whether the variable is nodal.

Returns
Whether the variable is nodal

Definition at line 234 of file KokkosVariable.h.

234{ return _nodal; }
Moose::Kokkos::Variable::_nodal
bool _nodal
Whether the variable is nodal.
Definition KokkosVariable.h:312

Referenced by Moose::Kokkos::Datum::isNodalDefined().

◆ old()

KOKKOS_FUNCTION bool Moose::Kokkos::Variable::old ( ) const
inline

Get whether the tag is old/older value.

Returns
Whether the tag is old/older value

Definition at line 249 of file KokkosVariable.h.

249{ return _old; }
Moose::Kokkos::Variable::_old
bool _old
Whether the tag is old/older value.
Definition KokkosVariable.h:324

Referenced by Moose::Kokkos::VariableGradientTempl< is_ad >::VariableGradientTempl(), and Moose::Kokkos::VariableValueTempl< is_ad >::VariableValueTempl().

◆ scalar()

KOKKOS_FUNCTION bool Moose::Kokkos::Variable::scalar ( ) const
inline

Get whether the variable is scalar.

Returns
Whether the variable is scalar

Definition at line 239 of file KokkosVariable.h.

239{ return _scalar; }
Moose::Kokkos::Variable::_scalar
bool _scalar
Whether the variable is scalar.
Definition KokkosVariable.h:316

◆ sys()

KOKKOS_FUNCTION unsigned int Moose::Kokkos::Variable::sys ( unsigned int  comp = 0) const
inline

Get the system number of a component.

Parameters
compThe variable component
Returns
The system number

Definition at line 276 of file KokkosVariable.h.

276{ return _sys[comp]; }
Moose::Kokkos::Variable::_sys
Array< unsigned int > _sys
System number of each component.
Definition KokkosVariable.h:348

Referenced by Moose::Kokkos::ResidualObject::accumulateTaggedElementalMatrix(), Moose::Kokkos::ResidualObject::accumulateTaggedElementalMatrix(), Moose::Kokkos::ResidualObject::accumulateTaggedElementalResidual(), Moose::Kokkos::LinearSystemContributionObject::accumulateTaggedMatrix(), Moose::Kokkos::ResidualObject::accumulateTaggedNodalMatrix(), Moose::Kokkos::ResidualObject::accumulateTaggedNodalMatrix(), Moose::Kokkos::ResidualObject::accumulateTaggedNodalResidual(), Moose::Kokkos::LinearSystemContributionObject::accumulateTaggedVector(), Moose::Kokkos::ResidualObject::accumulateTaggedVectorNodalMatrix(), Moose::Kokkos::ResidualObject::accumulateTaggedVectorNodalResidual(), KokkosCopyValueAux::computeElementInternal(), KokkosCopyValueAux::computeNodeInternal(), Moose::Kokkos::LinearFVFluxKernel::hasFaceNeighbor(), Moose::Kokkos::Datum::isNodalDefined(), Moose::Kokkos::VectorVariableValue::operator()(), Moose::Kokkos::VectorVariableGradient::operator()(), Moose::Kokkos::VectorVariableCurl::operator()(), Moose::Kokkos::LinearFVFluxKernel::operator()(), Moose::Kokkos::LinearFVFluxKernel::operator()(), Moose::Kokkos::LinearFVFluxKernel::operator()(), Moose::Kokkos::LinearFVFluxKernel::operator()(), Moose::Kokkos::NodalBC::operator()(), Moose::Kokkos::VectorNodalBC::operator()(), Moose::Kokkos::NodalKernel::operator()(), Moose::Kokkos::LinearFVElementalKernel::operator()(), Moose::Kokkos::AuxKernel::operator()(), Moose::Kokkos::IntegratedBC::operator()(), Moose::Kokkos::NodalBC::operator()(), Moose::Kokkos::VectorIntegratedBC::operator()(), Moose::Kokkos::VectorNodalBC::operator()(), Moose::Kokkos::Kernel::operator()(), Moose::Kokkos::VectorKernel::operator()(), Moose::Kokkos::NodalKernel::operator()(), Moose::Kokkos::IntegratedBC::operator()(), Moose::Kokkos::Kernel::operator()(), Moose::Kokkos::ADNodalBC::operator()(), Moose::Kokkos::NodalBC::operator()(), Moose::Kokkos::VectorNodalBC::operator()(), Moose::Kokkos::NodalKernel::operator()(), Moose::Kokkos::LinearFVElementalKernel::operator()(), Moose::Kokkos::AuxKernel::setElementSolution(), and Moose::Kokkos::AuxKernel::setNodeSolution().

◆ tag()

KOKKOS_FUNCTION TagID Moose::Kokkos::Variable::tag ( ) const
inline

Get the vector tag ID.

Returns
The vector tag ID

Definition at line 264 of file KokkosVariable.h.

264{ return _tag; }
Moose::Kokkos::Variable::_tag
TagID _tag
Vector tag ID.
Definition KokkosVariable.h:336

Referenced by KokkosCopyValueAux::computeElementInternal(), KokkosCopyValueAux::computeNodeInternal(), init(), init(), init(), init(), init(), Moose::Kokkos::VectorVariableValue::operator()(), Moose::Kokkos::VectorVariableGradient::operator()(), Moose::Kokkos::VectorVariableCurl::operator()(), Moose::Kokkos::AuxKernel::setElementSolution(), Moose::Kokkos::AuxKernel::setNodeSolution(), Variable(), Variable(), Variable(), Variable(), Variable(), Variable(), and Variable().

◆ value()

KOKKOS_FUNCTION Real Moose::Kokkos::Variable::value ( unsigned int  comp = 0) const
inline

Get the default value of a component.

Parameters
compThe variable component
Returns
The default value

Definition at line 282 of file KokkosVariable.h.

283 {
284 KOKKOS_ASSERT(!_coupled && !_vector);
285
286 return _default_value[comp];
287 }
Moose::Kokkos::Variable::_vector
bool _vector
Whether the variable is vector variable.
Definition KokkosVariable.h:328
Moose::Kokkos::Variable::_default_value
Array< Real > _default_value
Default value of each component when the variable is not coupled.
Definition KokkosVariable.h:352

◆ var()

KOKKOS_FUNCTION unsigned int Moose::Kokkos::Variable::var ( unsigned int  comp = 0) const
inline

Get the variable number of a component.

Parameters
compThe variable component
Returns
The variable number

Definition at line 270 of file KokkosVariable.h.

270{ return _var[comp]; }
Moose::Kokkos::Variable::_var
Array< unsigned int > _var
Variable number of each component.
Definition KokkosVariable.h:344

Referenced by Moose::Kokkos::ResidualObject::accumulateTaggedElementalMatrix(), Moose::Kokkos::ResidualObject::accumulateTaggedElementalMatrix(), Moose::Kokkos::ResidualObject::accumulateTaggedElementalResidual(), Moose::Kokkos::ResidualObject::accumulateTaggedNodalMatrix(), Moose::Kokkos::ResidualObject::accumulateTaggedNodalMatrix(), Moose::Kokkos::ResidualObject::accumulateTaggedNodalResidual(), Moose::Kokkos::ResidualObject::accumulateTaggedVectorNodalMatrix(), Moose::Kokkos::ResidualObject::accumulateTaggedVectorNodalResidual(), KokkosCopyValueAux::computeElementInternal(), KokkosCopyValueAux::computeNodeInternal(), Moose::Kokkos::LinearFVFluxKernel::hasFaceNeighbor(), Moose::Kokkos::Datum::isNodalDefined(), Moose::Kokkos::VectorVariableValue::operator()(), Moose::Kokkos::VectorVariableGradient::operator()(), Moose::Kokkos::VectorVariableCurl::operator()(), Moose::Kokkos::LinearFVFluxKernel::operator()(), Moose::Kokkos::LinearFVFluxKernel::operator()(), Moose::Kokkos::AuxKernel::operator()(), Moose::Kokkos::LinearFVFluxKernel::operator()(), Moose::Kokkos::LinearFVFluxKernel::operator()(), Moose::Kokkos::IntegratedBC::operator()(), Moose::Kokkos::NodalBC::operator()(), Moose::Kokkos::VectorIntegratedBC::operator()(), Moose::Kokkos::VectorNodalBC::operator()(), Moose::Kokkos::Kernel::operator()(), Moose::Kokkos::VectorKernel::operator()(), Moose::Kokkos::NodalKernel::operator()(), Moose::Kokkos::LinearFVElementalKernel::operator()(), Moose::Kokkos::AuxKernel::operator()(), Moose::Kokkos::IntegratedBC::operator()(), Moose::Kokkos::NodalBC::operator()(), Moose::Kokkos::VectorIntegratedBC::operator()(), Moose::Kokkos::VectorNodalBC::operator()(), Moose::Kokkos::Kernel::operator()(), Moose::Kokkos::VectorKernel::operator()(), Moose::Kokkos::NodalKernel::operator()(), Moose::Kokkos::IntegratedBC::operator()(), Moose::Kokkos::Kernel::operator()(), Moose::Kokkos::ADIntegratedBC::operator()(), Moose::Kokkos::ADNodalBC::operator()(), Moose::Kokkos::IntegratedBC::operator()(), Moose::Kokkos::NodalBC::operator()(), Moose::Kokkos::VectorIntegratedBC::operator()(), Moose::Kokkos::VectorNodalBC::operator()(), Moose::Kokkos::ADKernel::operator()(), Moose::Kokkos::Kernel::operator()(), Moose::Kokkos::VectorKernel::operator()(), Moose::Kokkos::NodalKernel::operator()(), Moose::Kokkos::LinearFVElementalKernel::operator()(), Moose::Kokkos::AuxKernel::setElementSolution(), Moose::Kokkos::AuxKernel::setNodeSolution(), Moose::Kokkos::VariableGradientTempl< is_ad >::VariableGradientTempl(), and Moose::Kokkos::VariableValueTempl< is_ad >::VariableValueTempl().

◆ vector()

KOKKOS_FUNCTION bool Moose::Kokkos::Variable::vector ( ) const
inline

Get whether the variable is vector variable.

Returns
Whether the variable is vector variable

Definition at line 254 of file KokkosVariable.h.

254{ return _vector; }

Referenced by Moose::Kokkos::checkVariable(), mooseFieldVar(), mooseScalarVar(), mooseVar(), sys(), value(), var(), Variable(), Variable(), Variable(), Variable(), Variable(), Variable(), Variable(), and vectorValue().

◆ vectorValue()

KOKKOS_FUNCTION Real3 Moose::Kokkos::Variable::vectorValue ( unsigned int  comp = 0) const
inline

Get the default vector value of a component.

Parameters
compThe variable component
Returns
The default vector value

Definition at line 293 of file KokkosVariable.h.

294 {
295 KOKKOS_ASSERT(!_coupled && _vector);
296
297 return _default_vector_value[comp];
298 }
Moose::Kokkos::Variable::_default_vector_value
Array< Real3 > _default_vector_value
Default vector value of each component when the variable is not coupled.
Definition KokkosVariable.h:356

Referenced by Moose::Kokkos::VectorVariableValue::operator()().

Member Data Documentation

◆ _components

unsigned int Moose::Kokkos::Variable::_components = 1
private

Number of components.

Definition at line 332 of file KokkosVariable.h.

Referenced by components().

◆ _coupled

bool Moose::Kokkos::Variable::_coupled = false
private

Whether the variable is coupled.

Definition at line 308 of file KokkosVariable.h.

Referenced by coupled(), value(), and vectorValue().

◆ _default_value

Array<Real> Moose::Kokkos::Variable::_default_value
private

Default value of each component when the variable is not coupled.

Definition at line 352 of file KokkosVariable.h.

Referenced by value().

◆ _default_vector_value

Array<Real3> Moose::Kokkos::Variable::_default_vector_value
private

Default vector value of each component when the variable is not coupled.

Definition at line 356 of file KokkosVariable.h.

Referenced by vectorValue().

◆ _dot

bool Moose::Kokkos::Variable::_dot = false
private

Whether the tag is time derivative.

Definition at line 320 of file KokkosVariable.h.

Referenced by dot().

◆ _initialized

bool Moose::Kokkos::Variable::_initialized = false
private

Whether the variable is initialized.

Definition at line 304 of file KokkosVariable.h.

Referenced by initialized().

◆ _moose_var

Array<const MooseVariableBase *> Moose::Kokkos::Variable::_moose_var
private

MOOSE variable of each component.

Definition at line 340 of file KokkosVariable.h.

Referenced by mooseFieldVar(), mooseScalarVar(), and mooseVar().

◆ _nodal

bool Moose::Kokkos::Variable::_nodal = false
private

Whether the variable is nodal.

Definition at line 312 of file KokkosVariable.h.

Referenced by nodal().

◆ _old

bool Moose::Kokkos::Variable::_old = false
private

Whether the tag is old/older value.

Definition at line 324 of file KokkosVariable.h.

Referenced by old().

◆ _scalar

bool Moose::Kokkos::Variable::_scalar = false
private

Whether the variable is scalar.

Definition at line 316 of file KokkosVariable.h.

Referenced by scalar().

◆ _sys

Array<unsigned int> Moose::Kokkos::Variable::_sys
private

System number of each component.

Definition at line 348 of file KokkosVariable.h.

Referenced by sys().

◆ _tag

TagID Moose::Kokkos::Variable::_tag = Moose::INVALID_TAG_ID
private

Vector tag ID.

Definition at line 336 of file KokkosVariable.h.

Referenced by tag().

◆ _var

Array<unsigned int> Moose::Kokkos::Variable::_var
private

Variable number of each component.

Definition at line 344 of file KokkosVariable.h.

Referenced by var().

◆ _vector

bool Moose::Kokkos::Variable::_vector = false
private

Whether the variable is vector variable.

Definition at line 328 of file KokkosVariable.h.

Referenced by value(), vector(), and vectorValue().

The documentation for this class was generated from the following file:
Generated on Mon Sep 28 2026 20:33:46 for https://mooseframework.inl.gov by doxygen 1.9.8