Abstract base class for specifying target cell sizes. More...

Inheritance diagram for cellSizeFunction:

[legend]

Collaboration diagram for cellSizeFunction:

[legend]

Public Types
enum	sideMode { smInside, smOutside, rmBothsides }

Public Types inherited from dictionary
typedef Searcher< true >	const_searcher

typedef Searcher< false >	searcher

Public Member Functions
	TypeName ("cellSizeFunction")

	declareRunTimeSelectionTable (autoPtr, cellSizeFunction, dictionary,(const dictionary &cellSizeFunctionDict, const searchableSurface &surface, const scalar &defaultCellSize, const labelList regionIndices),(cellSizeFunctionDict, surface, defaultCellSize, regionIndices))

	cellSizeFunction (const word &type, const dictionary &cellSizeFunctionDict, const searchableSurface &surface, const scalar &defaultCellSize, const labelList regionIndices)

virtual	~cellSizeFunction ()

const dictionary &	coeffsDict () const

virtual bool	sizeLocations (const pointIndexHit &hitPt, const vector &n, pointField &shapePts, scalarField &shapeSizes) const =0

virtual bool	cellSize (const point &pt, scalar &size) const =0

virtual bool	setCellSize (const pointField &pts)

label	priority () const

Public Member Functions inherited from dictionary
	ClassName ("dictionary")

	dictionary ()

	dictionary (const fileName &name)

	dictionary (const fileName &name, const dictionary &parentDict, Istream &is, bool keepHeader=false)

	dictionary (Istream &is)

	dictionary (Istream &is, bool keepHeader)

	dictionary (const dictionary &parentDict, const dictionary &dict)

	dictionary (const dictionary &dict)

	dictionary (const dictionary *dict)

	dictionary (const dictionary &parentDict, dictionary &&dict)

	dictionary (dictionary &&dict)

autoPtr< dictionary >	clone () const

virtual	~dictionary ()

const fileName &	name () const noexcept

fileName &	name () noexcept

word	dictName () const

fileName	relativeName (const bool caseTag=false) const

bool	isNullDict () const noexcept

const dictionary &	parent () const noexcept

const dictionary &	topDict () const

label	startLineNumber () const

label	endLineNumber () const

SHA1Digest	digest () const

tokenList	tokens () const

bool	found (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const

entry *	findEntry (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)

const entry *	findEntry (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const

const entry *	findScoped (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const

dictionary *	findDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)

const dictionary *	findDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const

const entry &	lookupEntry (const word &keyword, enum keyType::option matchOpt) const

ITstream &	lookup (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const

template<class T >
T	get (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const

template<class T >
T	getOrDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const

template<class T >
T	getOrAdd (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX)

template<class T >
bool	readEntry (const word &keyword, T &val, enum keyType::option matchOpt=keyType::REGEX, bool mandatory=true) const

template<class T >
bool	readIfPresent (const word &keyword, T &val, enum keyType::option matchOpt=keyType::REGEX) const

template<class T , class Predicate >
T	getCheck (const word &keyword, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const

template<class T , class Predicate >
T	getCheckOrDefault (const word &keyword, const T &deflt, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const

template<class T , class Predicate >
T	getCheckOrAdd (const word &keyword, const T &deflt, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX)

template<class T , class Predicate >
bool	readCheck (const word &keyword, T &val, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX, bool mandatory=true) const

template<class T , class Predicate >
bool	readCheckIfPresent (const word &keyword, T &val, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const

bool	isDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const

const dictionary &	subDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const

dictionary &	subDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)

dictionary &	subDictOrAdd (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)

dictionary	subOrEmptyDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX, const bool mandatory=false) const

const dictionary &	optionalSubDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const

wordList	toc () const

wordList	sortedToc () const

template<class Compare >
wordList	sortedToc (const Compare &comp) const

List< keyType >	keys (bool patterns=false) const

bool	substituteKeyword (const word &keyword, bool mergeEntry=false)

bool	substituteScopedKeyword (const word &keyword, bool mergeEntry=false)

entry *	add (entry *entryPtr, bool mergeEntry=false)

entry *	add (const entry &e, bool mergeEntry=false)

entry *	add (const keyType &k, const word &v, bool overwrite=false)

entry *	add (const keyType &k, const string &v, bool overwrite=false)

entry *	add (const keyType &k, const label v, bool overwrite=false)

entry *	add (const keyType &k, const scalar v, bool overwrite=false)

entry *	add (const keyType &k, const dictionary &d, bool mergeEntry=false)

template<class T >
entry *	add (const keyType &k, const T &v, bool overwrite=false)

entry *	set (entry *entryPtr)

entry *	set (const entry &e)

entry *	set (const keyType &k, const dictionary &v)

template<class T >
entry *	set (const keyType &k, const T &v)

bool	remove (const word &keyword)

bool	changeKeyword (const keyType &oldKeyword, const keyType &newKeyword, bool overwrite=false)

bool	merge (const dictionary &dict)

void	clear ()

void	transfer (dictionary &dict)

void	checkITstream (const ITstream &is, const word &keyword) const

bool	read (Istream &is)

bool	read (Istream &is, bool keepHeader)

void	writeEntry (Ostream &os) const

void	writeEntry (const keyType &keyword, Ostream &os) const

void	writeEntries (Ostream &os, const bool extraNewLine=false) const

void	write (Ostream &os, const bool subDict=true) const

const_searcher	csearch (const word &keyword, enum keyType::option=keyType::REGEX) const

const_searcher	search (const word &keyword, enum keyType::option=keyType::REGEX) const

searcher	search (const word &keyword, enum keyType::option=keyType::REGEX)

const_searcher	csearchScoped (const word &keyword, enum keyType::option) const

const_searcher	searchScoped (const word &keyword, enum keyType::option) const

searcher	searchScoped (const word &keyword, enum keyType::option)

const dictionary *	cfindScopedDict (const fileName &dictPath) const

const dictionary *	findScopedDict (const fileName &dictPath) const

dictionary *	findScopedDict (const fileName &dictPath)

dictionary *	makeScopedDict (const fileName &dictPath)

const_searcher	csearchCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const

bool	foundCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const

const entry *	findCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option) const

const entry &	lookupEntryCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option) const

ITstream &	lookupCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const

template<class T >
T	getCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const

template<class T >
T	getOrDefaultCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, const T &deflt, enum keyType::option=keyType::REGEX) const

template<class T >
bool	readCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, T &val, enum keyType::option=keyType::REGEX, bool mandatory=true) const

template<class T >
bool	readIfPresentCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, T &val, enum keyType::option=keyType::REGEX) const

void	operator= (const dictionary &rhs)

void	operator+= (const dictionary &rhs)

void	operator\|= (const dictionary &rhs)

void	operator<<= (const dictionary &rhs)

template<class T >
T	lookupOrDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const

template<class T >
T	lookupOrAddDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX)

template<class T >
T	lookupOrDefaultCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const

ITstream &	operator[] (const word &keyword) const

bool	found (const word &keyword, bool recursive, bool patternMatch=true) const

entry *	lookupEntryPtr (const word &keyword, bool recursive, bool patternMatch)

const entry *	lookupEntryPtr (const word &keyword, bool recursive, bool patternMatch) const

const entry *	lookupScopedEntryPtr (const word &keyword, bool recursive, bool patternMatch) const

const dictionary *	subDictPtr (const word &keyword) const

dictionary *	subDictPtr (const word &keyword)

const entry &	lookupEntry (const word &keyword, bool recursive, bool patternMatch) const

ITstream &	lookup (const word &keyword, bool recursive, bool patternMatch=true) const

template<class T >
T	lookupOrDefault (const word &keyword, const T &deflt, bool recursive, bool patternMatch=true) const

template<class T >
T	lookupOrAddDefault (const word &keyword, const T &deflt, bool recursive, bool patternMatch=true)

template<class T >
bool	readIfPresent (const word &keyword, T &val, bool recursive, bool patternMatch=true) const

template<class T >
T	lookupType (const word &keyword, bool recursive=false, bool patternMatch=true) const

bool	getBool (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Same as get< bool >(const word&, keyType::option) More...

label	getLabel (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Same as get< label >(const word&, keyType::option) More...

scalar	getScalar (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Same as get< scalar >(const word&, keyType::option) More...

string	getString (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Same as get< string >(const word&, keyType::option) More...

word	getWord (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Same as get< word >(const word&, keyType::option) More...

fileName	getFileName (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Same as get< fileName >(const word&, keyType::option) More...

template<class Compare >
Foam::wordList	sortedToc (const Compare &comp) const

template<class T >
Foam::entry *	add (const keyType &k, const T &v, bool overwrite)

template<class T >
Foam::entry *	set (const keyType &k, const T &v)

Public Member Functions inherited from ILList
	ILList ()=default

	ILList (T *item)

	ILList (Istream &is)

	ILList (const ILList< LListBase, T > &lst)

	ILList (ILList< LListBase, T > &&lst)

template<class CloneArg >
	ILList (const ILList< LListBase, T > &lst, const CloneArg &cloneArg)

template<class INew >
	ILList (Istream &is, const INew &inew)

	~ILList ()

bool	eraseHead ()

bool	erase (T *item)

void	clear ()

void	transfer (ILList< LListBase, T > &lst)

void	operator= (const ILList< LListBase, T > &lst)

void	operator= (ILList< LListBase, T > &&lst)

Static Public Member Functions
static autoPtr< cellSizeFunction >	New (const dictionary &cellSizeFunctionDict, const searchableSurface &surface, const scalar &defaultCellSize, const labelList regionIndices)

Static Public Member Functions inherited from dictionary
static int	reportOptional () noexcept

static int	reportOptional (const int level) noexcept

static autoPtr< dictionary >	New (Istream &is)

Protected Member Functions
	cellSizeFunction (const cellSizeFunction &)=delete

void	operator= (const cellSizeFunction &)=delete

Protected Attributes
const searchableSurface &	surface_

scalarField	surfaceCellSize_

autoPtr< surfaceCellSizeFunction >	surfaceCellSizeFunction_

dictionary	coeffsDict_

const scalar &	defaultCellSize_

const labelList	regionIndices_

sideMode	sideMode_

label	priority_

Static Protected Attributes
static scalar	snapToSurfaceTol_

Additional Inherited Members
Public Attributes inherited from dictionary
friend	const_searcher

friend	searcher

Static Public Attributes inherited from dictionary
static int	writeOptionalEntries

static const dictionary	null

static refPtr< OSstream >	reportingOutput

Detailed Description

Abstract base class for specifying target cell sizes.

Source files

Definition at line 52 of file cellSizeFunction.H.

Member Enumeration Documentation

◆ sideMode

enum sideMode

Enumerator
smInside
smOutside
rmBothsides

Definition at line 60 of file cellSizeFunction.H.

Constructor & Destructor Documentation

◆ cellSizeFunction() [1/2]

cellSizeFunction ( const cellSizeFunction & )

protecteddelete

◆ cellSizeFunction() [2/2]

cellSizeFunction	(	const word &	type,
		const dictionary &	cellSizeFunctionDict,
		const searchableSurface &	surface,
		const scalar &	defaultCellSize,
		const labelList	regionIndices
	)

◆ ~cellSizeFunction()

virtual ~cellSizeFunction ( )

virtual

Member Function Documentation

◆ TypeName()

TypeName ( "cellSizeFunction" )

◆ operator=()

void operator= ( const cellSizeFunction & )

protecteddelete

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	autoPtr	,
		cellSizeFunction	,
		dictionary	,
		(const dictionary &cellSizeFunctionDict, const searchableSurface &surface, const scalar &defaultCellSize, const labelList regionIndices)	,
		(cellSizeFunctionDict, surface, defaultCellSize, regionIndices)
	)

◆ New()

static autoPtr<cellSizeFunction> New	(	const dictionary &	cellSizeFunctionDict,
		const searchableSurface &	surface,
		const scalar &	defaultCellSize,
		const labelList	regionIndices
	)

static

◆ coeffsDict()

const dictionary& coeffsDict ( ) const

inline

Definition at line 166 of file cellSizeFunction.H.

References cellSizeFunction::coeffsDict_.

◆ sizeLocations()

virtual bool sizeLocations	(	const pointIndexHit &	hitPt,
		const vector &	n,
		pointField &	shapePts,
		scalarField &	shapeSizes
	)		const

pure virtual

Implemented in linearSpatial, surfaceOffsetLinearDistance, linearDistance, uniformDistance, and uniform.

◆ cellSize()

virtual bool cellSize	(	const point &	pt,
		scalar &	size
	)		const

pure virtual

Implemented in linearSpatial, surfaceOffsetLinearDistance, linearDistance, uniformDistance, and uniform.

◆ setCellSize()

virtual bool setCellSize ( const pointField & pts )

inlinevirtual

Reimplemented in linearDistance, uniformDistance, and uniform.

Definition at line 191 of file cellSizeFunction.H.

References Foam::endl(), and WarningInFunction.

Here is the call graph for this function:

◆ priority()

label priority ( ) const

inline

Definition at line 201 of file cellSizeFunction.H.

References cellSizeFunction::priority_.

Member Data Documentation

◆ snapToSurfaceTol_

scalar snapToSurfaceTol_

staticprotected

Definition at line 77 of file cellSizeFunction.H.

◆ surface_

const searchableSurface& surface_

protected

Definition at line 84 of file cellSizeFunction.H.

◆ surfaceCellSize_

scalarField surfaceCellSize_

protected

Definition at line 87 of file cellSizeFunction.H.

◆ surfaceCellSizeFunction_

autoPtr<surfaceCellSizeFunction> surfaceCellSizeFunction_

protected

Definition at line 89 of file cellSizeFunction.H.

◆ coeffsDict_

dictionary coeffsDict_

protected

Definition at line 92 of file cellSizeFunction.H.

Referenced by cellSizeFunction::coeffsDict().

◆ defaultCellSize_

const scalar& defaultCellSize_

protected

Definition at line 94 of file cellSizeFunction.H.

◆ regionIndices_

const labelList regionIndices_

protected

Definition at line 98 of file cellSizeFunction.H.

◆ sideMode_

sideMode sideMode_

protected

Definition at line 101 of file cellSizeFunction.H.

◆ priority_

label priority_

protected

Definition at line 103 of file cellSizeFunction.H.

Referenced by cellSizeFunction::priority().

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

applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/cellSizeControlSurfaces/cellSizeFunction/cellSizeFunction/cellSizeFunction.H

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ sideMode

Constructor & Destructor Documentation

◆ cellSizeFunction() [1/2]

◆ cellSizeFunction() [2/2]

◆ ~cellSizeFunction()

Member Function Documentation

◆ TypeName()

◆ operator=()

◆ declareRunTimeSelectionTable()

◆ New()

◆ coeffsDict()

◆ sizeLocations()

◆ cellSize()

◆ setCellSize()

◆ priority()

Member Data Documentation

◆ snapToSurfaceTol_

◆ surface_

◆ surfaceCellSize_

◆ surfaceCellSizeFunction_

◆ coeffsDict_

◆ defaultCellSize_

◆ regionIndices_

◆ sideMode_

◆ priority_