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::ScalarMassElemKernel< AlgTraits > Class Template Reference

CMM (BDF2/BE) for scalar equation. More...

#include <ScalarMassElemKernel.h>

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

Public Member Functions

 ScalarMassElemKernel (const stk::mesh::BulkData &, const SolutionOptions &, ScalarFieldType *, ElemDataRequests &, const bool)
 
virtual ~ScalarMassElemKernel ()
 
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...
 
- Public Member Functions inherited from sierra::nalu::Kernel
 Kernel ()=default
 
virtual ~Kernel ()
 

Private Member Functions

 ScalarMassElemKernel ()=delete
 

Private Attributes

ScalarFieldType * scalarQNm1_ {nullptr}
 
ScalarFieldType * scalarQN_ {nullptr}
 
ScalarFieldType * scalarQNp1_ {nullptr}
 
ScalarFieldType * densityNm1_ {nullptr}
 
ScalarFieldType * densityN_ {nullptr}
 
ScalarFieldType * densityNp1_ {nullptr}
 
VectorFieldType * coordinates_ {nullptr}
 
double dt_ {0.0}
 
double gamma1_ {0.0}
 
double gamma2_ {0.0}
 
double gamma3_ {0.0}
 
const bool lumpedMass_
 
const int * ipNodeMap_
 Integration point to node mapping. More...
 
Kokkos::View< DoubleType[AlgTraits::numScvIp_][AlgTraits::nodesPerElement_]> v_shape_function_ {"view_shape_func"}
 Shape functions. More...
 

Detailed Description

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

CMM (BDF2/BE) for scalar equation.

Constructor & Destructor Documentation

template<typename AlgTraits >
sierra::nalu::ScalarMassElemKernel< AlgTraits >::ScalarMassElemKernel ( const stk::mesh::BulkData &  bulkData,
const SolutionOptions &  solnOpts,
ScalarFieldType *  scalarQ,
ElemDataRequests &  dataPreReqs,
const bool  lumpedMass 
)

References sierra::nalu::ElemDataRequests::add_coordinates_field(), sierra::nalu::ElemDataRequests::add_cvfem_volume_me(), sierra::nalu::ElemDataRequests::add_gathered_nodal_field(), sierra::nalu::ElemDataRequests::add_master_element_call(), sierra::nalu::ScalarMassElemKernel< AlgTraits >::coordinates_, sierra::nalu::CURRENT_COORDINATES, sierra::nalu::ScalarMassElemKernel< AlgTraits >::densityN_, sierra::nalu::ScalarMassElemKernel< AlgTraits >::densityNm1_, sierra::nalu::ScalarMassElemKernel< AlgTraits >::densityNp1_, sierra::nalu::SolutionOptions::get_coordinates_name(), sierra::nalu::MasterElementRepo::get_volume_master_element(), sierra::nalu::ScalarMassElemKernel< AlgTraits >::lumpedMass_, sierra::nalu::ScalarMassElemKernel< AlgTraits >::scalarQN_, sierra::nalu::ScalarMassElemKernel< AlgTraits >::scalarQNm1_, sierra::nalu::ScalarMassElemKernel< AlgTraits >::scalarQNp1_, sierra::nalu::SCV_VOLUME, and sierra::nalu::ScalarMassElemKernel< AlgTraits >::v_shape_function_.

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

Member Function Documentation

template<typename AlgTraits >
void sierra::nalu::ScalarMassElemKernel< 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.

Reimplemented from sierra::nalu::Kernel.

References sierra::nalu::CURRENT_COORDINATES, sierra::nalu::ScalarMassElemKernel< AlgTraits >::densityN_, sierra::nalu::ScalarMassElemKernel< AlgTraits >::densityNm1_, sierra::nalu::ScalarMassElemKernel< AlgTraits >::densityNp1_, sierra::nalu::ScalarMassElemKernel< AlgTraits >::dt_, sierra::nalu::ScalarMassElemKernel< AlgTraits >::gamma1_, sierra::nalu::ScalarMassElemKernel< AlgTraits >::gamma2_, sierra::nalu::ScalarMassElemKernel< AlgTraits >::gamma3_, sierra::nalu::ScratchViews< T >::get_me_views(), sierra::nalu::ScratchViews< T >::get_scratch_view_1D(), sierra::nalu::INSTANTIATE_KERNEL(), sierra::nalu::ScalarMassElemKernel< AlgTraits >::ipNodeMap_, anonymous_namespace{UnitTestContinuityAdvElem.C}::hex8_golds::advection_default::lhs, anonymous_namespace{UnitTestContinuityAdvElem.C}::hex8_golds::advection_default::rhs, sierra::nalu::ScalarMassElemKernel< AlgTraits >::scalarQN_, sierra::nalu::ScalarMassElemKernel< AlgTraits >::scalarQNm1_, sierra::nalu::ScalarMassElemKernel< AlgTraits >::scalarQNp1_, and sierra::nalu::ScalarMassElemKernel< AlgTraits >::v_shape_function_.

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

Perform pre-timestep work for the computational kernel.

Reimplemented from sierra::nalu::Kernel.

References sierra::nalu::ScalarMassElemKernel< AlgTraits >::dt_, sierra::nalu::ScalarMassElemKernel< AlgTraits >::gamma1_, sierra::nalu::ScalarMassElemKernel< AlgTraits >::gamma2_, sierra::nalu::ScalarMassElemKernel< AlgTraits >::gamma3_, sierra::nalu::TimeIntegrator::get_gamma1(), sierra::nalu::TimeIntegrator::get_gamma2(), sierra::nalu::TimeIntegrator::get_gamma3(), and sierra::nalu::TimeIntegrator::get_time_step().

Member Data Documentation

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

Referenced by sierra::nalu::ScalarMassElemKernel< AlgTraits >::ScalarMassElemKernel().

template<typename AlgTraits >
ScalarFieldType* sierra::nalu::ScalarMassElemKernel< AlgTraits >::densityN_ {nullptr}
private

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

template<typename AlgTraits >
ScalarFieldType* sierra::nalu::ScalarMassElemKernel< AlgTraits >::densityNm1_ {nullptr}
private

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

template<typename AlgTraits >
ScalarFieldType* sierra::nalu::ScalarMassElemKernel< AlgTraits >::densityNp1_ {nullptr}
private

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

template<typename AlgTraits >
double sierra::nalu::ScalarMassElemKernel< AlgTraits >::dt_ {0.0}
private

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

template<typename AlgTraits >
double sierra::nalu::ScalarMassElemKernel< AlgTraits >::gamma1_ {0.0}
private

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

template<typename AlgTraits >
double sierra::nalu::ScalarMassElemKernel< AlgTraits >::gamma2_ {0.0}
private

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

template<typename AlgTraits >
double sierra::nalu::ScalarMassElemKernel< AlgTraits >::gamma3_ {0.0}
private

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

template<typename AlgTraits >
const int* sierra::nalu::ScalarMassElemKernel< AlgTraits >::ipNodeMap_
private

Integration point to node mapping.

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

template<typename AlgTraits >
const bool sierra::nalu::ScalarMassElemKernel< AlgTraits >::lumpedMass_
private

Referenced by sierra::nalu::ScalarMassElemKernel< AlgTraits >::ScalarMassElemKernel().

template<typename AlgTraits >
ScalarFieldType* sierra::nalu::ScalarMassElemKernel< AlgTraits >::scalarQN_ {nullptr}
private

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

template<typename AlgTraits >
ScalarFieldType* sierra::nalu::ScalarMassElemKernel< AlgTraits >::scalarQNm1_ {nullptr}
private

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

template<typename AlgTraits >
ScalarFieldType* sierra::nalu::ScalarMassElemKernel< AlgTraits >::scalarQNp1_ {nullptr}
private

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

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

Shape functions.

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

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