waves
Basic FE playground
katoptron::SourcesList< scalar > Class Template Reference

Class which is used to store the list of the volumetric heat sources. More...

#include <SourcesList.h>

Public Member Functions

 SourcesList ()
 
 SourcesList (Problem &pbl, Teuchos::RCP< Map > map, Teuchos::RCP< ElementsList > elementsList)
 SourcesList constructor. More...
 
local_ordinal_type getSourceNumber ()
 Return the number of sources. More...
 
local_ordinal_type getSourceSize (local_ordinal_type i)
 Return the number of elements for a given source. More...
 
local_ordinal_type getSourceElement (local_ordinal_type i, local_ordinal_type ea)
 Return the local ID of the element e1 of a source. More...
 
scalar getSourceValue (local_ordinal_type i)
 Return the value of the source. More...
 

Private Types

typedef Map::local_ordinal_type local_ordinal_type
 
typedef Map::global_ordinal_type global_ordinal_type
 

Private Attributes

Kokkos::View< int **, Kokkos::LayoutRight > sources_elementsList
 
Kokkos::View< scalar ***, Kokkos::LayoutRight > sources_values_list
 
local_ordinal_type sources_number
 
local_ordinal_type sources_size
 
local_ordinal_type sources_elements
 
local_ordinal_type sources_time
 
local_ordinal_type sources_values
 

Detailed Description

template<typename scalar>
class katoptron::SourcesList< scalar >

Class which is used to store the list of the volumetric heat sources.

Member Typedef Documentation

◆ global_ordinal_type

template<typename scalar >
typedef Map::global_ordinal_type katoptron::SourcesList< scalar >::global_ordinal_type
private

◆ local_ordinal_type

template<typename scalar >
typedef Map::local_ordinal_type katoptron::SourcesList< scalar >::local_ordinal_type
private

Constructor & Destructor Documentation

◆ SourcesList() [1/2]

template<typename scalar >
katoptron::SourcesList< scalar >::SourcesList ( )

◆ SourcesList() [2/2]

template<typename scalar >
katoptron::SourcesList< scalar >::SourcesList ( Problem pbl,
Teuchos::RCP< Map map,
Teuchos::RCP< ElementsList elementsList 
)

SourcesList constructor.

This constructor allocates 2 Kokkos::View which store all the required information related to source, including:

  • all the source elements,
  • all the values of the heat source.

Arguments:

  • pbl: a Problem object,
  • map: an RCP to a Map object,
  • elementsList: an RCP to an ElementList object.

Member Function Documentation

◆ getSourceElement()

template<typename scalar >
local_ordinal_type katoptron::SourcesList< scalar >::getSourceElement ( local_ordinal_type  i,
local_ordinal_type  ea 
)
inline

Return the local ID of the element e1 of a source.

Arguments:

  • i: the source ID,
  • e1: the ID of the element on the current BC.

◆ getSourceNumber()

template<typename scalar >
local_ordinal_type katoptron::SourcesList< scalar >::getSourceNumber ( )
inline

Return the number of sources.

◆ getSourceSize()

template<typename scalar >
local_ordinal_type katoptron::SourcesList< scalar >::getSourceSize ( local_ordinal_type  i)
inline

Return the number of elements for a given source.

Argument:

  • i: the source ID.

◆ getSourceValue()

template<typename scalar >
scalar katoptron::SourcesList< scalar >::getSourceValue ( local_ordinal_type  i)
inline

Return the value of the source.

Argument:

  • i: the source ID.

Member Data Documentation

◆ sources_elements

template<typename scalar >
local_ordinal_type katoptron::SourcesList< scalar >::sources_elements
private

◆ sources_elementsList

template<typename scalar >
Kokkos::View<int **, Kokkos::LayoutRight> katoptron::SourcesList< scalar >::sources_elementsList
private

◆ sources_number

template<typename scalar >
local_ordinal_type katoptron::SourcesList< scalar >::sources_number
private

◆ sources_size

template<typename scalar >
local_ordinal_type katoptron::SourcesList< scalar >::sources_size
private

◆ sources_time

template<typename scalar >
local_ordinal_type katoptron::SourcesList< scalar >::sources_time
private

◆ sources_values

template<typename scalar >
local_ordinal_type katoptron::SourcesList< scalar >::sources_values
private

◆ sources_values_list

template<typename scalar >
Kokkos::View<scalar ***, Kokkos::LayoutRight> katoptron::SourcesList< scalar >::sources_values_list
private

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