waLBerla 7.2
Loading...
Searching...
No Matches
Public Member Functions | List of all members
walberla::field::Creator< GhostLayerField_T > Struct Template Reference

Detailed Description

template<typename GhostLayerField_T>
struct walberla::field::Creator< GhostLayerField_T >

BlockDataCreator for fields.

Use this class when different fields should be added for different selectors.

Example for making the field layout selector dependent:

BlockDataID fieldId = blocks->addBlockData( "my data field" )
<< field::Creator< MyField_T >( blocks, "my data field (zyxf)", NONE, FZYX, 0, field::zyxf )
<< field::Creator< MyField_T >( blocks, "my data field (fzyx)", FZYX, NONE, 0, field::fzyx );
walberla::domain_decomposition::BlockDataID
Definition BlockDataID.h:42
walberla::field::zyxf
@ zyxf
Cell-sorted data layout, (f should be innermost loop)
Definition Layout.h:35
walberla::field::fzyx
@ fzyx
Value-sorted data layout (f should be outermost loop)
Definition Layout.h:34
walberla::field::Creator
BlockDataCreator for fields.
Definition AddToStorage.h:313

#include <AddToStorage.h>

+ Inheritance diagram for walberla::field::Creator< GhostLayerField_T >:

Public Member Functions

 Creator (const shared_ptr< StructuredBlockStorage > &blocks, const std::string &identifier, const Set< SUID > &requiredSelectors, const Set< SUID > &incompatibleSelectors, const typename GhostLayerField_T::value_type &initValue=typename GhostLayerField_T::value_type(), const Layout layout=fzyx, const uint_t nrOfGhostLayers=uint_t(1), const bool=false, const std::function< void(GhostLayerField_T *field, IBlock *const block) > &initFunction=std::function< void(GhostLayerField_T *field, IBlock *const block) >())
 
 Creator (const std::string &identifier=std::string(), const Set< SUID > &requiredSelectors=Set< SUID >::emptySet(), const Set< SUID > &incompatibleSelectors=Set< SUID >::emptySet(), const typename GhostLayerField_T::value_type &=typename GhostLayerField_T::value_type(), const Layout=fzyx, const uint_t=uint_t(1))
 
- Public Member Functions inherited from walberla::domain_decomposition::BlockDataCreator< GhostLayerField_T >
 BlockDataCreator (const shared_ptr< U > &dataHandling, const std::string &identifier=std::string(), const Set< SUID > &requiredSelectors=Set< SUID >::emptySet(), const Set< SUID > &incompatibleSelectors=Set< SUID >::emptySet())
 
 BlockDataCreator (const std::function< GhostLayerField_T *(IBlock *const block) > &function, const std::string &identifier=std::string(), const Set< SUID > &requiredSelectors=Set< SUID >::emptySet(), const Set< SUID > &incompatibleSelectors=Set< SUID >::emptySet())
 

Additional Inherited Members

- Public Attributes inherited from walberla::domain_decomposition::BlockDataCreator< GhostLayerField_T >
shared_ptr< BlockDataHandling< GhostLayerField_T > > dataHandling_
 
std::string identifier_
 
Set< SUID > requiredSelectors_
 
Set< SUID > incompatibleSelectors_
 

Constructor & Destructor Documentation

◆ Creator() [1/2]

template<typename GhostLayerField_T >
walberla::field::Creator< GhostLayerField_T >::Creator ( const shared_ptr< StructuredBlockStorage > & blocks,
const std::string & identifier,
const Set< SUID > & requiredSelectors,
const Set< SUID > & incompatibleSelectors,
const typename GhostLayerField_T::value_type & initValue = typename GhostLayerField_T::value_type(),
const Layout layout = fzyx,
const uint_t nrOfGhostLayers = uint_t(1),
const bool = false,
const std::function< void(GhostLayerField_T *field, IBlock *const block) > & initFunction = std::function< void ( GhostLayerField_T * field, IBlock * const block ) >() )
inline

◆ Creator() [2/2]

template<typename GhostLayerField_T >
walberla::field::Creator< GhostLayerField_T >::Creator ( const std::string & identifier = std::string(),
const Set< SUID > & requiredSelectors = Set<SUID>::emptySet(),
const Set< SUID > & incompatibleSelectors = Set<SUID>::emptySet(),
const typename GhostLayerField_T::value_type & = typename GhostLayerField_T::value_type(),
const Layout = fzyx,
const uint_t = uint_t(1) )
inline
The documentation for this struct was generated from the following file: