Nalu
Nalu: a generalized unstructured massively parallel low Mach flow code designed to support a variety of energy applications of interest (most notably Wind ECP) built on the Sierra Toolkit and Trilinos solver Tpetra/Epetra stack. The open source BSD, clause 3 license model has been chosen for the code base. See LICENSE for more information. http://NaluCFD.org
Public Member Functions | Private Member Functions | Private Attributes | List of all members
sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits > Class Template Reference

CVFEM scalar upwind advection/diffusion kernel. More...

#include <ScalarUpwAdvDiffElemKernel.h>

Inheritance diagram for sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >:
sierra::nalu::Kernel

Public Member Functions

 ScalarUpwAdvDiffElemKernel (const stk::mesh::BulkData &, const SolutionOptions &, EquationSystem *, ScalarFieldType *, VectorFieldType *, ScalarFieldType *, ElemDataRequests &)
 
virtual ~ScalarUpwAdvDiffElemKernel ()
 
virtual void setup (const TimeIntegrator &)
 Perform pre-timestep work for the computational kernel. More...
 
virtual void execute (SharedMemView< DoubleType ** > &, SharedMemView< DoubleType * > &, ScratchViews< DoubleType > &)
 Execute the kernel within a Kokkos loop and populate the LHS and RHS for the linear solve. More...
 
virtual DoubleType van_leer (const DoubleType &dqm, const DoubleType &dqp)
 
- Public Member Functions inherited from sierra::nalu::Kernel
 Kernel ()=default
 
virtual ~Kernel ()
 

Private Member Functions

 ScalarUpwAdvDiffElemKernel ()=delete
 

Private Attributes

const SolutionOptions & solnOpts_
 
ScalarFieldType * scalarQ_ {nullptr}
 
VectorFieldType * Gjq_ {nullptr}
 
ScalarFieldType * diffFluxCoeff_ {nullptr}
 
VectorFieldType * velocityRTM_ {nullptr}
 
ScalarFieldType * density_ {nullptr}
 
VectorFieldType * coordinates_ {nullptr}
 
GenericFieldType * massFlowRate_ {nullptr}
 
const int * lrscv_
 Left right node indicators. More...
 
const std::string dofName_
 Name of the primitive variable (for upwind options lookup in solution options) More...
 
double alpha_
 
double alphaUpw_
 
double hoUpwind_
 
bool useLimiter_
 
double om_alpha_
 
double om_alphaUpw_
 
const bool shiftedGradOp_
 
const double small_ {1.0e-16}
 
PecletFunction * pecletFunction_ {nullptr}
 Peclet function. More...
 
Kokkos::View< DoubleType[AlgTraits::numScsIp_][AlgTraits::nodesPerElement_]> v_shape_function_ { "view_shape_func" }
 Shape functions. More...
 

Detailed Description

template<typename AlgTraits>
class sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >

CVFEM scalar upwind advection/diffusion kernel.

Constructor & Destructor Documentation

template<typename AlgTraits >
sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::ScalarUpwAdvDiffElemKernel ( const stk::mesh::BulkData &  bulkData,
const SolutionOptions &  solnOpts,
EquationSystem *  eqSystem,
ScalarFieldType *  scalarQ,
VectorFieldType *  Gjq,
ScalarFieldType *  diffFluxCoeff,
ElemDataRequests &  dataPreReqs 
)

References sierra::nalu::ElemDataRequests::add_coordinates_field(), sierra::nalu::ElemDataRequests::add_cvfem_surface_me(), sierra::nalu::ElemDataRequests::add_element_field(), sierra::nalu::ElemDataRequests::add_gathered_nodal_field(), sierra::nalu::ElemDataRequests::add_master_element_call(), sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::coordinates_, sierra::nalu::CURRENT_COORDINATES, sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::density_, sierra::nalu::SolutionOptions::does_mesh_move(), sierra::nalu::SolutionOptions::get_coordinates_name(), sierra::nalu::MasterElementRepo::get_surface_master_element(), sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::massFlowRate_, sierra::nalu::SCS_AREAV, sierra::nalu::SCS_GRAD_OP, sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::shiftedGradOp_, sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::v_shape_function_, and sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::velocityRTM_.

template<typename AlgTraits >
sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::~ScalarUpwAdvDiffElemKernel ( )
virtual

References sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::pecletFunction_.

template<typename AlgTraits >
sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::ScalarUpwAdvDiffElemKernel ( )
privatedelete

Member Function Documentation

template<typename AlgTraits >
void sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::execute ( SharedMemView< DoubleType ** > &  lhs,
SharedMemView< DoubleType * > &  rhs,
ScratchViews< DoubleType > &  scratchViews 
)
virtual

Execute the kernel within a Kokkos loop and populate the LHS and RHS for the linear solve.

Scratch space to hold coordinates at the integration point

Reimplemented from sierra::nalu::Kernel.

References sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::alpha_, sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::alphaUpw_, sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::coordinates_, sierra::nalu::CURRENT_COORDINATES, sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::density_, sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::diffFluxCoeff_, sierra::nalu::PecletFunction::execute(), sierra::nalu::ScratchViews< T >::get_me_views(), sierra::nalu::ScratchViews< T >::get_scratch_view_1D(), sierra::nalu::ScratchViews< T >::get_scratch_view_2D(), sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::Gjq_, sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::hoUpwind_, anonymous_namespace{UnitTestContinuityAdvElem.C}::hex8_golds::advection_default::lhs, sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::lrscv_, sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::massFlowRate_, sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::om_alpha_, sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::om_alphaUpw_, sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::pecletFunction_, anonymous_namespace{UnitTestContinuityAdvElem.C}::hex8_golds::advection_default::rhs, sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::scalarQ_, sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::shiftedGradOp_, sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::small_, sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::useLimiter_, sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::v_shape_function_, sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::van_leer(), and sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::velocityRTM_.

template<typename AlgTraits >
void sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::setup ( const TimeIntegrator &  )
virtual

Perform pre-timestep work for the computational kernel.

Reimplemented from sierra::nalu::Kernel.

References sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::alpha_, sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::alphaUpw_, sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::dofName_, sierra::nalu::SolutionOptions::get_alpha_factor(), sierra::nalu::SolutionOptions::get_alpha_upw_factor(), sierra::nalu::SolutionOptions::get_upw_factor(), sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::hoUpwind_, sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::om_alpha_, sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::om_alphaUpw_, sierra::nalu::SolutionOptions::primitive_uses_limiter(), sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::solnOpts_, and sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::useLimiter_.

template<class AlgTraits >
DoubleType sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::van_leer ( const DoubleType &  dqm,
const DoubleType &  dqp 
)
virtual

References sierra::nalu::INSTANTIATE_KERNEL(), and sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::small_.

Referenced by sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::execute().

Member Data Documentation

template<typename AlgTraits >
double sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::alpha_
private

Referenced by sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::execute(), and sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::setup().

template<typename AlgTraits >
double sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::alphaUpw_
private

Referenced by sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::execute(), and sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::setup().

template<typename AlgTraits >
VectorFieldType* sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::coordinates_ {nullptr}
private

Referenced by sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::execute(), and sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::ScalarUpwAdvDiffElemKernel().

template<typename AlgTraits >
ScalarFieldType* sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::density_ {nullptr}
private

Referenced by sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::execute(), and sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::ScalarUpwAdvDiffElemKernel().

template<typename AlgTraits >
ScalarFieldType* sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::diffFluxCoeff_ {nullptr}
private

Referenced by sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::execute().

template<typename AlgTraits >
const std::string sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::dofName_
private

Name of the primitive variable (for upwind options lookup in solution options)

Referenced by sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::setup().

template<typename AlgTraits >
VectorFieldType* sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::Gjq_ {nullptr}
private

Referenced by sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::execute().

template<typename AlgTraits >
double sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::hoUpwind_
private

Referenced by sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::execute(), and sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::setup().

template<typename AlgTraits >
const int* sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::lrscv_
private

Left right node indicators.

Referenced by sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::execute().

template<typename AlgTraits >
GenericFieldType* sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::massFlowRate_ {nullptr}
private

Referenced by sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::execute(), and sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::ScalarUpwAdvDiffElemKernel().

template<typename AlgTraits >
double sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::om_alpha_
private

Referenced by sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::execute(), and sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::setup().

template<typename AlgTraits >
double sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::om_alphaUpw_
private

Referenced by sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::execute(), and sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::setup().

template<typename AlgTraits >
PecletFunction* sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::pecletFunction_ {nullptr}
private

Peclet function.

Referenced by sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::execute(), and sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::~ScalarUpwAdvDiffElemKernel().

template<typename AlgTraits >
ScalarFieldType* sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::scalarQ_ {nullptr}
private

Referenced by sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::execute().

template<typename AlgTraits >
const bool sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::shiftedGradOp_
private

Referenced by sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::execute(), and sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::ScalarUpwAdvDiffElemKernel().

template<typename AlgTraits >
const double sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::small_ {1.0e-16}
private

Referenced by sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::execute(), and sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::van_leer().

template<typename AlgTraits >
const SolutionOptions& sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::solnOpts_
private

Referenced by sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::setup().

template<typename AlgTraits >
bool sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::useLimiter_
private

Referenced by sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::execute(), and sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::setup().

template<typename AlgTraits >
Kokkos::View<DoubleType[AlgTraits::numScsIp_][AlgTraits::nodesPerElement_]> sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::v_shape_function_ { "view_shape_func" }
private

Shape functions.

Referenced by sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::execute(), and sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::ScalarUpwAdvDiffElemKernel().

template<typename AlgTraits >
VectorFieldType* sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::velocityRTM_ {nullptr}
private

Referenced by sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::execute(), and sierra::nalu::ScalarUpwAdvDiffElemKernel< AlgTraits >::ScalarUpwAdvDiffElemKernel().

The documentation for this class was generated from the following files:
Generated by   doxygen 1.8.11