NeoN
A framework for CFD software
Loading...
Searching...
No Matches
Public Member Functions | List of all members
NeoN::finiteVolume::cellCentred::BoundaryContext Class Reference

Carries named field references for context-aware boundary conditions. More...

#include <boundaryContext.hpp>

Public Member Functions

void insert (std::string name, const VolumeField< scalar > &f)
 
void insert (std::string name, const VolumeField< Vec3 > &f)
 
void insert (std::string name, const VolumeField< Tensor > &f)
 
void insert (std::string name, const SurfaceField< scalar > &f)
 
const VolumeField< scalar > & scalarFieldPtr (const std::string &name) const
 
const VolumeField< Vec3 > & vectorFieldPtr (const std::string &name) const
 
const VolumeField< Tensor > & tensorFieldPtr (const std::string &name) const
 
const SurfaceField< scalar > & surfaceScalarField (const std::string &name) const
 
bool hasScalar (const std::string &name) const noexcept
 
bool hasVector (const std::string &name) const noexcept
 
bool hasTensor (const std::string &name) const noexcept
 
bool hasSurfaceScalar (const std::string &name) const noexcept
 

Detailed Description

Carries named field references for context-aware boundary conditions.

Boundary conditions that need auxiliary fields (U, nu, nearWallDist, omega, k …) look up what they need by name instead of accepting a fixed argument list. Volume fields cover wall functions; the surface-scalar slot carries the face flux phi consumed by flux-dependent BCs such as inletOutlet. All fields are stored as non-owning const pointers; the caller is responsible for ensuring the lifetime of the referenced fields exceeds the context.

Definition at line 35 of file boundaryContext.hpp.

Member Function Documentation

◆ hasScalar()

bool NeoN::finiteVolume::cellCentred::BoundaryContext::hasScalar ( const std::string &  name) const
noexcept

◆ hasSurfaceScalar()

bool NeoN::finiteVolume::cellCentred::BoundaryContext::hasSurfaceScalar ( const std::string &  name) const
noexcept

◆ hasTensor()

bool NeoN::finiteVolume::cellCentred::BoundaryContext::hasTensor ( const std::string &  name) const
noexcept

◆ hasVector()

bool NeoN::finiteVolume::cellCentred::BoundaryContext::hasVector ( const std::string &  name) const
noexcept

◆ insert() [1/4]

void NeoN::finiteVolume::cellCentred::BoundaryContext::insert ( std::string  name,
const SurfaceField< scalar > &  f 
)

◆ insert() [2/4]

void NeoN::finiteVolume::cellCentred::BoundaryContext::insert ( std::string  name,
const VolumeField< scalar > &  f 
)

◆ insert() [3/4]

void NeoN::finiteVolume::cellCentred::BoundaryContext::insert ( std::string  name,
const VolumeField< Tensor > &  f 
)

◆ insert() [4/4]

void NeoN::finiteVolume::cellCentred::BoundaryContext::insert ( std::string  name,
const VolumeField< Vec3 > &  f 
)

◆ scalarFieldPtr()

const VolumeField< scalar > & NeoN::finiteVolume::cellCentred::BoundaryContext::scalarFieldPtr ( const std::string &  name) const

◆ surfaceScalarField()

const SurfaceField< scalar > & NeoN::finiteVolume::cellCentred::BoundaryContext::surfaceScalarField ( const std::string &  name) const

◆ tensorFieldPtr()

const VolumeField< Tensor > & NeoN::finiteVolume::cellCentred::BoundaryContext::tensorFieldPtr ( const std::string &  name) const

◆ vectorFieldPtr()

const VolumeField< Vec3 > & NeoN::finiteVolume::cellCentred::BoundaryContext::vectorFieldPtr ( const std::string &  name) const

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