NeoN
WIP Prototype of a modern OpenFOAM core
|
Namespaces | |
namespace | detail |
namespace | dsl |
namespace | finiteVolume |
namespace | la |
namespace | sundials |
namespace | timeIntegration |
Classes | |
class | ArgList |
class | BaseClassData |
Represents the data for a base class. More... | |
class | BaseClassDocumentation |
Provides a mechanism for registering and retrieving documentation for base and derived classes. More... | |
class | BoundaryData |
Represents the boundary fields for a computational domain. More... | |
class | BoundaryMesh |
Represents boundaries of an unstructured mesh. More... | |
class | Collection |
A type-erased interface collection types. More... | |
class | CollectionMixin |
A mixin class for collection of documents in a database to simplify the implementation of common operations. More... | |
class | CPUExecutor |
Executor for handling multicore CPU based parallelization. More... | |
class | Database |
class | DerivedClassDocumentation |
Class representing the documentation for a derived class. More... | |
class | Dictionary |
A class representing a dictionary that stores key-value pairs. More... | |
class | DimensionMismatch |
Error for handling two containers of incompatible lengths. More... | |
class | Document |
A class representing a document in a database. More... | |
class | Error |
Base class for consistent error representation. More... | |
class | Field |
Represents the domain fields for a computational domain. More... | |
class | GPUExecutor |
Executor for GPU offloading. More... | |
class | NeoNException |
Custom exception class for NeoN. More... | |
struct | Parameters |
struct | RegisterDocumentation |
Template struct for registering documentation of a base class. More... | |
class | RuntimeSelectionFactory |
A factory class for runtime selection of derived classes. More... | |
class | RuntimeSelectionFactory< Base, Parameters< Args... > > |
class | SegmentedVector |
Data structure that stores a segmented fields or a vector of vectors. More... | |
class | SegmentedVectorView |
A class representing a segment of indices. More... | |
class | SerialExecutor |
Reference executor for serial CPU execution. More... | |
class | StencilDataBase |
A class that represents a stencil database. More... | |
struct | SumKernel |
class | Time |
class | TokenList |
A class representing a list of tokens. More... | |
class | UnstructuredMesh |
Represents an unstructured mesh in NeoN. More... | |
class | Vec3 |
A class for the representation of a 3D Vec3. More... | |
class | Vector |
A class to contain the data and executors for a field and define some basic operations. More... | |
class | View |
Concepts | |
concept | parallelForKernel |
concept | parallelForVectorKernel |
Typedefs | |
using | DocumentValidator = std::function< bool(Dictionary)> |
A type alias for a function that validates a Dictionary object. | |
using | Executor = std::variant< SerialExecutor, CPUExecutor, GPUExecutor > |
using | Input = std::variant< Dictionary, TokenList > |
using | label = int32_t |
using | localIdx = int32_t |
using | globalIdx = int64_t |
using | size_t = std::size_t |
using | mpi_label_t = int |
typedef float | scalar |
using | word = std::string |
using | labelVector = NeoN::Vector< label > |
using | localIdxVector = NeoN::Vector< localIdx > |
using | scalarVector = NeoN::Vector< scalar > |
using | vectorVector = NeoN::Vector< Vec3 > |
Functions | |
template<typename Type > | |
void | validateRegistration (const Type &field, const std::string &errorMessage) |
Validates that a field is registered in the database. | |
bool | hasId (Dictionary doc) |
Checks if a Dictionary object has an "id" key. | |
const std::string & | name (const NeoN::Document &doc) |
Retrieves the name of a Document. | |
std::string & | name (NeoN::Document &doc) |
Retrieves the name of a Document. | |
std::string | demangle (const char *mangledName) |
template<typename T , typename Container , typename Key > | |
void | logBadAnyCast (const std::bad_any_cast &e, const Key &key, const Container &data) |
void | logOutRange (const std::out_of_range &e, const std::string &key, const std::unordered_map< std::string, std::any > &data) |
bool | operator== (const Executor &lhs, const Executor &rhs) |
Checks if two executors are equal, i.e. they are of the same type. | |
bool | operator!= (const Executor &lhs, const Executor &rhs) |
Checks if two executors are not equal, i.e. they are not of the same type. | |
template<class DataClass > | |
DataClass | read (Input input) |
template<typename Executor , parallelForKernel Kernel> | |
void | parallelFor (const Executor &exec, std::pair< localIdx, localIdx > range, Kernel kernel, std::string name="parallelFor") |
template<parallelForKernel Kernel> | |
void | parallelFor (const NeoN::Executor &exec, std::pair< localIdx, localIdx > range, Kernel kernel, std::string name="parallelFor") |
template<typename Executor , typename ValueType , parallelForVectorKernel< ValueType > Kernel> | |
void | parallelFor (const Executor &exec, Vector< ValueType > &field, Kernel kernel, std::string name="parallelFor") |
template<typename ValueType , parallelForVectorKernel< ValueType > Kernel> | |
void | parallelFor (Vector< ValueType > &field, Kernel kernel, std::string name="parallelFor") |
template<typename Executor , typename Kernel , typename T > | |
void | parallelReduce (const Executor &exec, std::pair< localIdx, localIdx > range, Kernel kernel, T &value) |
template<typename Kernel , typename T > | |
void | parallelReduce (const NeoN::Executor &exec, std::pair< localIdx, localIdx > range, Kernel kernel, T &value) |
template<typename Executor , typename ValueType , typename Kernel , typename T > | |
void | parallelReduce (const Executor &exec, Vector< ValueType > &field, Kernel kernel, T &value) |
template<typename ValueType , typename Kernel , typename T > | |
void | parallelReduce (Vector< ValueType > &field, Kernel kernel, T &value) |
template<typename Executor , typename Kernel > | |
void | parallelScan (const Executor &exec, std::pair< localIdx, localIdx > range, Kernel kernel) |
template<typename Kernel > | |
void | parallelScan (const NeoN::Executor &exec, std::pair< localIdx, localIdx > range, Kernel kernel) |
template<typename Executor , typename Kernel , typename ReturnType > | |
void | parallelScan (const Executor &exec, std::pair< localIdx, localIdx > range, Kernel kernel, ReturnType &returnValue) |
template<typename Kernel , typename ReturnType > | |
void | parallelScan (const NeoN::Executor &exec, std::pair< localIdx, localIdx > range, Kernel kernel, ReturnType &returnValue) |
template<> | |
KOKKOS_INLINE_FUNCTION localIdx | one< localIdx > () |
template<> | |
KOKKOS_INLINE_FUNCTION localIdx | zero< localIdx > () |
KOKKOS_INLINE_FUNCTION scalar | mag (const scalar &s) |
template<> | |
KOKKOS_INLINE_FUNCTION scalar | one< scalar > () |
template<> | |
KOKKOS_INLINE_FUNCTION scalar | zero< scalar > () |
template<typename T > | |
KOKKOS_INLINE_FUNCTION T | one () |
template<typename T > | |
KOKKOS_INLINE_FUNCTION T | zero () |
KOKKOS_INLINE_FUNCTION Vec3 | operator* (const scalar &sclr, Vec3 rhs) |
KOKKOS_INLINE_FUNCTION scalar | operator& (const Vec3 &lhs, Vec3 rhs) |
KOKKOS_INLINE_FUNCTION scalar | mag (const Vec3 &vec) |
std::ostream & | operator<< (std::ostream &out, const Vec3 &vec) |
template<> | |
KOKKOS_INLINE_FUNCTION Vec3 | one< Vec3 > () |
template<> | |
KOKKOS_INLINE_FUNCTION Vec3 | zero< Vec3 > () |
void | logOutRange (const std::out_of_range &e, const std::size_t &key, const std::vector< std::any > &data) |
template<typename T > | |
Vector< T > | operator+ (Vector< T > lhs, const Vector< T > &rhs) |
Arithmetic add operator, addition of two fields. | |
template<typename T > | |
Vector< T > | operator- (Vector< T > lhs, const Vector< T > &rhs) |
Arithmetic subtraction operator, subtraction one field from another. | |
template<typename T , typename Inner > | |
void | map (Vector< T > &a, const Inner inner, std::pair< localIdx, localIdx > range={0, 0}) |
Map a field using a specific executor. | |
template<typename ValueType > | |
void | fill (Vector< ValueType > &a, const std::type_identity_t< ValueType > value, std::pair< localIdx, localIdx > range={0, 0}) |
Fill the field with a scalar value using a specific executor. | |
template<typename ValueType > | |
void | setVector (Vector< ValueType > &a, const View< const std::type_identity_t< ValueType > > b, std::pair< localIdx, localIdx > range={0, 0}) |
Set the field with a view of values using a specific executor. | |
template<typename ValueType > | |
void | scalarMul (Vector< ValueType > &a, const scalar value) |
template<typename ValueType > | |
void | add (Vector< ValueType > &a, const Vector< std::type_identity_t< ValueType > > &b) |
template<typename ValueType > | |
void | sub (Vector< ValueType > &a, const Vector< std::type_identity_t< ValueType > > &b) |
template<typename ValueType > | |
void | mul (Vector< ValueType > &a, const Vector< std::type_identity_t< ValueType > > &b) |
template<typename... Args> | |
auto | spans (Args &... fields) |
template<typename... Args> | |
auto | copyToHosts (Args &... fields) |
template<typename T > | |
bool | equal (Vector< T > &field, T value) |
template<typename T > | |
bool | equal (const Vector< T > &field, const Vector< T > &field2) |
template<typename T > | |
bool | equal (const Vector< T > &field, View< T > span2) |
template<typename IndexType > | |
IndexType | segmentsFromIntervals (const Vector< IndexType > &intervals, Vector< IndexType > &offsets) |
Compute segment offsets from an input field corresponding to lengths by computing a prefix sum. | |
UnstructuredMesh | createSingleCellMesh (const Executor exec) |
creates a mesh containing only a single cell @warn currently this is only a 2D mesh | |
UnstructuredMesh | create1DUniformMesh (const Executor exec, const localIdx nCells) |
A factory function for a 1D mesh. | |
Variables | |
constexpr scalar | ROOTVSMALL = 1e-18 |
A type alias for a function that validates a Dictionary object.
This type alias represents a function that takes a Dictionary object as an argument and returns a boolean value indicating whether the Dictionary is valid or not.
Example usage:
Definition at line 30 of file document.hpp.
using NeoN::Executor = typedef std::variant<SerialExecutor, CPUExecutor, GPUExecutor> |
Definition at line 16 of file executor.hpp.
using NeoN::globalIdx = typedef int64_t |
using NeoN::Input = typedef std::variant<Dictionary, TokenList> |
using NeoN::label = typedef int32_t |
using NeoN::labelVector = typedef NeoN::Vector<label> |
Definition at line 13 of file fieldTypeDefs.hpp.
using NeoN::localIdx = typedef int32_t |
using NeoN::localIdxVector = typedef NeoN::Vector<localIdx> |
Definition at line 14 of file fieldTypeDefs.hpp.
using NeoN::mpi_label_t = typedef int |
typedef float NeoN::scalar |
Definition at line 14 of file scalar.hpp.
using NeoN::scalarVector = typedef NeoN::Vector<scalar> |
Definition at line 15 of file fieldTypeDefs.hpp.
using NeoN::size_t = typedef std::size_t |
using NeoN::vectorVector = typedef NeoN::Vector<Vec3> |
Definition at line 16 of file fieldTypeDefs.hpp.
using NeoN::word = typedef std::string |
void NeoN::add | ( | Vector< ValueType > & | a, |
const Vector< std::type_identity_t< ValueType > > & | b | ||
) |
Definition at line 119 of file fieldFreeFunctions.hpp.
auto NeoN::copyToHosts | ( | Args &... | fields | ) |
Definition at line 150 of file fieldFreeFunctions.hpp.
UnstructuredMesh NeoN::create1DUniformMesh | ( | const Executor | exec, |
const localIdx | nCells | ||
) |
A factory function for a 1D mesh.
A 1D mesh in 3D space in which each cell has a left and a right face. The 1D mesh is aligned with the x coordinate of Cartesian coordinate system.
UnstructuredMesh NeoN::createSingleCellMesh | ( | const Executor | exec | ) |
creates a mesh containing only a single cell @warn currently this is only a 2D mesh
a 2D mesh in 3D space with left, right, top, bottom boundary faces with the centre at (0.5, 0.5, 0.0) left, top, right, bottom faces and four boundaries one left, right, top, bottom
std::string NeoN::demangle | ( | const char * | mangledName | ) |
Definition at line 171 of file fieldFreeFunctions.hpp.
Definition at line 193 of file fieldFreeFunctions.hpp.
bool NeoN::equal | ( | Vector< T > & | field, |
T | value | ||
) |
Definition at line 156 of file fieldFreeFunctions.hpp.
void NeoN::fill | ( | Vector< ValueType > & | a, |
const std::type_identity_t< ValueType > | value, | ||
std::pair< localIdx, localIdx > | range = {0, 0} |
||
) |
Fill the field with a scalar value using a specific executor.
field | The field to fill. |
value | The scalar value to fill the field with. |
range | The range to fill the field in. If not provided, the whole field is filled. |
Definition at line 50 of file fieldFreeFunctions.hpp.
bool NeoN::hasId | ( | Dictionary | doc | ) |
Checks if a Dictionary object has an "id" key.
This function checks if the given Dictionary object has an "id" key.
doc | The Dictionary object to check. |
void NeoN::logBadAnyCast | ( | const std::bad_any_cast & | e, |
const Key & | key, | ||
const Container & | data | ||
) |
Definition at line 19 of file demangle.hpp.
void NeoN::logOutRange | ( | const std::out_of_range & | e, |
const std::size_t & | key, | ||
const std::vector< std::any > & | data | ||
) |
void NeoN::logOutRange | ( | const std::out_of_range & | e, |
const std::string & | key, | ||
const std::unordered_map< std::string, std::any > & | data | ||
) |
Definition at line 20 of file scalar.hpp.
void NeoN::map | ( | Vector< T > & | a, |
const Inner | inner, | ||
std::pair< localIdx, localIdx > | range = {0, 0} |
||
) |
Map a field using a specific executor.
a | The field to map. |
inner | The function to apply to each element of the field. |
range | The range to map the field in. If not provided, the whole field is mapped. |
Definition at line 29 of file fieldFreeFunctions.hpp.
void NeoN::mul | ( | Vector< ValueType > & | a, |
const Vector< std::type_identity_t< ValueType > > & | b | ||
) |
Definition at line 136 of file fieldFreeFunctions.hpp.
const std::string & NeoN::name | ( | const NeoN::Document & | doc | ) |
std::string & NeoN::name | ( | NeoN::Document & | doc | ) |
KOKKOS_INLINE_FUNCTION T NeoN::one | ( | ) |
Definition at line 24 of file scalar.hpp.
Checks if two executors are not equal, i.e. they are not of the same type.
lhs | The first executor. |
rhs | The second executor. |
Definition at line 51 of file executor.hpp.
Arithmetic add operator, addition of two fields.
lhs | The field to add with this field. |
rhs | The field to add with this field. |
Definition at line 460 of file vector.hpp.
Arithmetic subtraction operator, subtraction one field from another.
lhs | The field to subtract from. |
rhs | The field to subtract by. |
Definition at line 473 of file vector.hpp.
std::ostream & NeoN::operator<< | ( | std::ostream & | out, |
const Vec3 & | vec | ||
) |
Checks if two executors are equal, i.e. they are of the same type.
lhs | The first executor. |
rhs | The second executor. |
Definition at line 24 of file executor.hpp.
void NeoN::parallelFor | ( | const Executor & | exec, |
std::pair< localIdx, localIdx > | range, | ||
Kernel | kernel, | ||
std::string | name = "parallelFor" |
||
) |
Definition at line 28 of file parallelAlgorithms.hpp.
void NeoN::parallelFor | ( | const Executor & | exec, |
Vector< ValueType > & | field, | ||
Kernel | kernel, | ||
std::string | name = "parallelFor" |
||
) |
Definition at line 75 of file parallelAlgorithms.hpp.
void NeoN::parallelFor | ( | const NeoN::Executor & | exec, |
std::pair< localIdx, localIdx > | range, | ||
Kernel | kernel, | ||
std::string | name = "parallelFor" |
||
) |
Definition at line 56 of file parallelAlgorithms.hpp.
void NeoN::parallelFor | ( | Vector< ValueType > & | field, |
Kernel | kernel, | ||
std::string | name = "parallelFor" |
||
) |
Definition at line 103 of file parallelAlgorithms.hpp.
void NeoN::parallelReduce | ( | const Executor & | exec, |
std::pair< localIdx, localIdx > | range, | ||
Kernel | kernel, | ||
T & | value | ||
) |
Definition at line 109 of file parallelAlgorithms.hpp.
void NeoN::parallelReduce | ( | const Executor & | exec, |
Vector< ValueType > & | field, | ||
Kernel | kernel, | ||
T & | value | ||
) |
Definition at line 150 of file parallelAlgorithms.hpp.
void NeoN::parallelReduce | ( | const NeoN::Executor & | exec, |
std::pair< localIdx, localIdx > | range, | ||
Kernel | kernel, | ||
T & | value | ||
) |
Definition at line 141 of file parallelAlgorithms.hpp.
void NeoN::parallelReduce | ( | Vector< ValueType > & | field, |
Kernel | kernel, | ||
T & | value | ||
) |
Definition at line 179 of file parallelAlgorithms.hpp.
void NeoN::parallelScan | ( | const Executor & | exec, |
std::pair< localIdx, localIdx > | range, | ||
Kernel | kernel | ||
) |
Definition at line 185 of file parallelAlgorithms.hpp.
void NeoN::parallelScan | ( | const Executor & | exec, |
std::pair< localIdx, localIdx > | range, | ||
Kernel | kernel, | ||
ReturnType & | returnValue | ||
) |
Definition at line 201 of file parallelAlgorithms.hpp.
void NeoN::parallelScan | ( | const NeoN::Executor & | exec, |
std::pair< localIdx, localIdx > | range, | ||
Kernel | kernel | ||
) |
Definition at line 195 of file parallelAlgorithms.hpp.
void NeoN::parallelScan | ( | const NeoN::Executor & | exec, |
std::pair< localIdx, localIdx > | range, | ||
Kernel | kernel, | ||
ReturnType & | returnValue | ||
) |
Definition at line 216 of file parallelAlgorithms.hpp.
DataClass NeoN::read | ( | Input | input | ) |
Definition at line 94 of file fieldFreeFunctions.hpp.
IndexType NeoN::segmentsFromIntervals | ( | const Vector< IndexType > & | intervals, |
Vector< IndexType > & | offsets | ||
) |
Compute segment offsets from an input field corresponding to lengths by computing a prefix sum.
The offsets are computed by a prefix sum of the input values. So, with given input of {1, 2, 3, 4, 5} the offsets are {0, 1, 3, 6, 10, 15}. Note that the length of offSpan must be length of intervals + 1 and are all elements of offSpan are required to be zero
[in] | in | The values to compute the offsets from. |
[in,out] | offsets | The field to store the resulting offsets in. |
Definition at line 25 of file segmentedVector.hpp.
void NeoN::setVector | ( | Vector< ValueType > & | a, |
const View< const std::type_identity_t< ValueType > > | b, | ||
std::pair< localIdx, localIdx > | range = {0, 0} |
||
) |
Set the field with a view of values using a specific executor.
a | The field to set. |
b | The view of values to set the field with. |
range | The range to set the field in. If not provided, the whole field is set. |
Definition at line 76 of file fieldFreeFunctions.hpp.
auto NeoN::spans | ( | Args &... | fields | ) |
Definition at line 144 of file fieldFreeFunctions.hpp.
void NeoN::sub | ( | Vector< ValueType > & | a, |
const Vector< std::type_identity_t< ValueType > > & | b | ||
) |
Definition at line 128 of file fieldFreeFunctions.hpp.
void NeoN::validateRegistration | ( | const Type & | field, |
const std::string & | errorMessage | ||
) |
Validates that a field is registered in the database.
Type | The type of the field. |
field | The field to validate. |
errorMessage | The error message |
std::runtime_error | if the field is not registered in the database. |
Definition at line 120 of file database.hpp.
KOKKOS_INLINE_FUNCTION T NeoN::zero | ( | ) |
KOKKOS_INLINE_FUNCTION localIdx NeoN::zero< localIdx > | ( | ) |
KOKKOS_INLINE_FUNCTION scalar NeoN::zero< scalar > | ( | ) |
Definition at line 30 of file scalar.hpp.
KOKKOS_INLINE_FUNCTION Vec3 NeoN::zero< Vec3 > | ( | ) |
|
constexpr |
Definition at line 17 of file scalar.hpp.