Abstract base class for providing relaxation values to the cell motion controller. More...

Inheritance diagram for relaxationModel:

[legend]

Collaboration diagram for relaxationModel:

Public Member Functions
	TypeName ("relaxationModel")

	declareRunTimeSelectionTable (autoPtr, relaxationModel, dictionary,(const dictionary &relaxationDict, const Time &runTime),(relaxationDict, runTime))

	relaxationModel (const word &type, const dictionary &relaxationDict, const Time &runTime)

virtual	~relaxationModel ()=default

const dictionary &	coeffDict () const

virtual scalar	relaxation ()=0

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< relaxationModel >	New (const dictionary &relaxationDict, const Time &runTime)

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
	relaxationModel (const relaxationModel &)=delete

void	operator= (const relaxationModel &)=delete

Protected Attributes
const Time &	runTime_

dictionary	coeffDict_

Additional Inherited Members
Public Types inherited from dictionary
typedef Searcher< true >	const_searcher

typedef Searcher< false >	searcher

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 providing relaxation values to the cell motion controller.

Source files

Definition at line 51 of file relaxationModel.H.

Constructor & Destructor Documentation

◆ relaxationModel() [1/2]

relaxationModel ( const relaxationModel & )

protecteddelete

◆ relaxationModel() [2/2]

relaxationModel	(	const word &	type,
		const dictionary &	relaxationDict,
		const Time &	runTime
	)

◆ ~relaxationModel()

virtual ~relaxationModel ( )

virtualdefault

Member Function Documentation

◆ operator=()

void operator= ( const relaxationModel & )

protecteddelete

◆ TypeName()

TypeName ( "relaxationModel" )

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	autoPtr	,
		relaxationModel	,
		dictionary	,
		(const dictionary &relaxationDict, const Time &runTime)	,
		(relaxationDict, runTime)
	)

◆ New()

static autoPtr<relaxationModel> New	(	const dictionary &	relaxationDict,
		const Time &	runTime
	)

static

◆ coeffDict()

const dictionary& coeffDict ( ) const

inline

Definition at line 125 of file relaxationModel.H.

References relaxationModel::coeffDict_.

◆ relaxation()

virtual scalar relaxation ( )

pure virtual

Implemented in rampHoldFall, and adaptiveLinear.

Member Data Documentation

◆ runTime_

const Time& runTime_

protected

Definition at line 61 of file relaxationModel.H.

◆ coeffDict_

dictionary coeffDict_

protected

Definition at line 64 of file relaxationModel.H.

Referenced by relaxationModel::coeffDict().

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

applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/relaxationModel/relaxationModel/relaxationModel.H

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members