Feel::Checker Class Reference

Checker class. More...

Inheritance diagram for Feel::Checker:

Collaboration diagram for Feel::Checker:

Public Types
using	variables_t = std::map< std::string, std::string >
Public Types inherited from Feel::JournalWatcher
using	function_update_information_type = std::function< void(nl::json &)>
using	notify_type = nl::json

Public Member Functions
bool	check () const
	Checker (Checker &&c)=default
	Checker (Checker const &c)=default
	Checker (std::string const &name="")
std::optional< std::string > const &	gradient () const
std::string const &	gradientKey () const
bool	hasGradient () const
Checker &	operator= (Checker &&c)=default
Checker &	operator= (Checker const &c)=default
	use More...
std::map< std::string, double > const &	parameterValues () const
template<typename ErrorFn , typename ErrorLaw >
int	runOnce (ErrorFn fn, ErrorLaw law, std::string metric="||u-u_h||_")
template<typename ErrorFn , typename ErrorRate >
int	runOnce (ErrorFn fn, ErrorRate rate, std::string metric)
variables_t	runScript ()
void	setCheck (bool c)
void	setGradient (std::string const &s, std::string const &key="gradient")
void	setGradientKey (std::string const &key)
void	setParameterValues (std::map< std::string, double > const &p)
void	setScript (std::string const &s, variables_t const &inputs={}, std::map< std::string, double > const &params={}, bool use=true)
	set the script to configure a PDE from a set of coefficient using a script
void	setSolution (std::string const &s, std::string const &key="solution")
void	setUseScript (bool u)
void	setVerbose (bool v)
std::string const &	solution () const
bool	useScript () const
bool	verbose () const
Public Member Functions inherited from Feel::JournalWatcher
	JournalWatcher (std::string const &category="", std::string const &name="", bool connect=JournalManager::journalAutoMode())
	Constructors. More...
	JournalWatcher (std::string const &category, bool useDefaultName, bool connect=JournalManager::journalAutoMode())
	JournalWatcher (function_update_information_type const &func, std::string const &category="", std::string const &name="", bool useDefaultNameIfEmpty=true, bool connect=JournalManager::journalAutoMode())
	JournalWatcher (JournalWatcher const &jw)
	Copy constructor.
virtual	~JournalWatcher ()
	Default destructor. The (inherited) object is always disconnected from the journal during the destruction.
bool	journalIsConnected () const
	GettersCheck if the object is connected to the journal. More...
std::string const &	journalWatcherInstanceName () const
	Return the full instance name for this watched object. The name is composed with the base name and a suffix index corresponding to the nth call. More...
nl::json::json_pointer	journalSection () const
	Return the section into the journal as json_pointer.
nl::json const &	informationObject () const
	Return the information into property tree.
void	journalConnect ()
	Setters. More...
void	journalDisconnect ()
	Disconnect the derived object from the simulation info manager. The disconnection is safe.
virtual void	updateInformationObject (nl::json &p) const
	update information object into p More...
void	setInformationObject (nl::json const &informationObject)
	set information object
void	putInformationObject (nl::json const &informationObject)
	put information object
void	addInformationObject (nl::json const &informationObject)
	add information object
void	journalFinalize ()
	finalize journal publication

Additional Inherited Members
Protected Member Functions inherited from Feel::JournalWatcher
void	applyUpdateInformationObject ()
	Protected Methods.

Detailed Description

Checker class.

for PDE solve When solving PDEs, we want to check that we get proper convergence rates using a priori error estimates.

The Checker class

Member Function Documentation

operator=()

Checker & Feel::Checker::operator= ( Checker const &  c )

default

use

Parameters

s	as solution to check the numerical results

setUseScript()

void Feel::Checker::setUseScript

(

bool

u

)

Returns

true if use the script, false otherwise

useScript()

bool Feel::Checker::useScript

(

)

const

Returns

true if use the script, false otherwise