NeoN::finiteVolume::cellCentred::FieldDatabaseMixin Class Reference

Mixin for database registration for fields (volume/surface). More...

#include <fieldDatabase.hpp>

Inheritance diagram for NeoN::finiteVolume::cellCentred::FieldDatabaseMixin:

Public Member Functions
	FieldDatabaseMixin ()=default
	FieldDatabaseMixin (Database &db, std::string keyIn, std::string collectionName)
bool	hasDatabase () const
Database &	db ()
const Database &	db () const
bool	registered () const

Public Attributes
std::string	key
std::string	fieldCollectionName

Protected Attributes
std::optional< Database * >	db_

Detailed Description

Mixin for database registration for fields (volume/surface).

Provides:

• optional Database* storage
• key, fieldCollectionName
• hasDatabase(), db(), registered()

Definition at line 24 of file fieldDatabase.hpp.

Constructor & Destructor Documentation

FieldDatabaseMixin() [1/2]

NeoN::finiteVolume::cellCentred::FieldDatabaseMixin::FieldDatabaseMixin ( )

default

FieldDatabaseMixin() [2/2]

NeoN::finiteVolume::cellCentred::FieldDatabaseMixin::FieldDatabaseMixin ( Database &  db, std::string  keyIn, std::string  collectionName  )

inline

Definition at line 30 of file fieldDatabase.hpp.

Member Function Documentation

db() [1/2]

Database & NeoN::finiteVolume::cellCentred::FieldDatabaseMixin::db ( )

inline

Definition at line 36 of file fieldDatabase.hpp.

db() [2/2]

const Database & NeoN::finiteVolume::cellCentred::FieldDatabaseMixin::db ( ) const

inline

Definition at line 47 of file fieldDatabase.hpp.

hasDatabase()

bool NeoN::finiteVolume::cellCentred::FieldDatabaseMixin::hasDatabase ( ) const

inline

Definition at line 34 of file fieldDatabase.hpp.

registered()

bool NeoN::finiteVolume::cellCentred::FieldDatabaseMixin::registered ( ) const

inline

Definition at line 59 of file fieldDatabase.hpp.

Member Data Documentation

db_

std::optional<Database*> NeoN::finiteVolume::cellCentred::FieldDatabaseMixin::db_

protected

Definition at line 70 of file fieldDatabase.hpp.

fieldCollectionName

std::string NeoN::finiteVolume::cellCentred::FieldDatabaseMixin::fieldCollectionName

Definition at line 66 of file fieldDatabase.hpp.

key

std::string NeoN::finiteVolume::cellCentred::FieldDatabaseMixin::key

Definition at line 65 of file fieldDatabase.hpp.

---

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

• /home/runner/work/NeoN/NeoN/include/NeoN/core/database/fieldDatabase.hpp