Explicit function manager. More...

Typedefs
using	IntVec = std::vector< int >
	Convenience type alias. More...

using	RealVec = std::vector< double >
	Convenience type alias. More...

Functions
double	getValue (int baseID, const IntVec &intVars, const RealVec &realVars, const double x, int &ierr)
	Evaluates an explicit function. More...

double	getValue (int baseID, int fType, int extrap, const RealVec &realVars, const double x, int &ierr)
	Evaluates an explicit function. More...

double	getDerivative (int baseID, int fType, int extrap, const RealVec &realVars, const double x, int &ierr)
	Evaluates the derivative of an explicit function. More...

int	getSmartPoints (int funcType, int extrap, const double start, const double stop, const RealVec &realVars, RealVec &xtofill, RealVec &ytofill)
	Finds the so-called smart points of an explicit function. More...

int	getTypeID (const std::string &functionType)
	Returns the function type ID for a given functionType name. More...

bool	initWaveFunction (const std::string &fileName, const int nWave, const int rSeed, RealVec &realVars)
	Initializes parameters for a wave function from given file. More...

bool	initWaveFunction (const int iop, const int nWave, const int nDir, const int sprExp, const int rSeed, RealVec &realVars)
	Initializes parameters for a wave function from a wave spectrum. More...

bool	initWaveFunction (const int iop, const double g, double d, RealVec &realVars)
	Initializes parameters for a non-linear wave function. More...

bool	initWaveFunction (const int iop, const int nWave, const int rSeed, const double g, const double d, IntVec &intVars, RealVec &realVars)
	Initializes parameters for an embedded non-linear wave function. More...

double	getWaveValue (const RealVec &realVars, const double g, const double d, const FaVec3 &x, const double t, int iop=0)
	Evaluates a wave profile function. More...

double	getWaveValue (const IntVec &intVars, const RealVec &realVars, const double g, const double d, const FaVec3 &x, const double t, int iop=0)
	Evaluates a wave profile function. More...

double	getWaveValue (const IntVec &intVars, const RealVec &realVars, const double g, const double d, const FaVec3 &x, const double t, FaVec3 &v, FaVec3 &a, int iop=0)
	Evaluates a wave profile including velocity and acceleration. More...

Detailed Description

Explicit function manager.

Typedef Documentation

◆ IntVec

using FFaFunctionManager::IntVec = typedef std::vector<int>

Convenience type alias.

◆ RealVec

using FFaFunctionManager::RealVec = typedef std::vector<double>

Convenience type alias.

Function Documentation

◆ getDerivative()

double FFaFunctionManager::getDerivative	(	int	baseID,
		int	fType,
		int	extrap,
		const RealVec &	realVars,
		const double	x,
		int &	ierr
	)

Evaluates the derivative of an explicit function.

Parameters

[in]	baseID	base ID of the function to be evaluated
[in]	fType	Function type identifier
[in]	extrap	Extrapolation flag
[in]	realVars	Real function parameters
[in]	x	Function argument
[out]	ierr	Error flag

See also: The fortran routine getfunctionderiv().

◆ getSmartPoints()

int FFaFunctionManager::getSmartPoints	(	int	funcType,
		int	extrap,
		const double	start,
		const double	stop,
		const RealVec &	realVars,
		RealVec &	xtofill,
		RealVec &	ytofill
	)

Finds the so-called smart points of an explicit function.

Parameters

[in]	funcType	Function type identifier
[in]	extrap	Extrapolation flag
[in]	start	Start argument value of the function domain to consider
[in]	stop	Stop argument value of the function domain to consider
[in]	realVars	Real function parameters
[out]	xtofill	Function argument values of the smart points
[out]	ytofill	Function values of the smart points

See also: FFaFunctionProperties::getSmartPoints().

◆ getTypeID()

int FFaFunctionManager::getTypeID ( const std::string & functionType )

Returns the function type ID for a given functionType name.

See also: The fortran routine getfunctiontypeid().

◆ getValue() [1/2]

double FFaFunctionManager::getValue	(	int	baseID,
		const IntVec &	intVars,
		const RealVec &	realVars,
		const double	x,
		int &	ierr
	)

Evaluates an explicit function.

Parameters

[in]	baseID	base ID of the function to be evaluated
[in]	intVars	Integer function parameters
[in]	realVars	Real function parameters
[in]	x	Function argument
[out]	ierr	Error flag

See also: The fortran routine getfunctionvalue().

◆ getValue() [2/2]

double FFaFunctionManager::getValue	(	int	baseID,
		int	fType,
		int	extrap,
		const RealVec &	realVars,
		const double	x,
		int &	ierr
	)

Evaluates an explicit function.

Parameters

[in]	baseID	base ID of the function to be evaluated
[in]	fType	Function type identifier
[in]	extrap	Extrapolation flag
[in]	realVars	Real function parameters
[in]	x	Function argument
[out]	ierr	Error flag

See also: The fortran routine getfunctionvalue().

◆ getWaveValue() [1/3]

double FFaFunctionManager::getWaveValue	(	const IntVec &	intVars,
		const RealVec &	realVars,
		const double	g,
		const double	d,
		const FaVec3 &	x,
		const double	t,
		FaVec3 &	v,
		FaVec3 &	a,
		int	iop = `0`
	)

Evaluates a wave profile including velocity and acceleration.

Parameters

[in]	intVars	Integer wave function parameters
[in]	realVars	Real wave function parameters
[in]	g	Gravity constant
[in]	d	Water depth
[in]	x	Position to evaluate wave profile at
[in]	t	Time to evaluate wave profile at
[out]	v	Water particle velocity
[out]	a	Water particle acceleration
[in]	iop	Wave model option

Returns: Wave elevation

See also: The fortran routine evalwave().

◆ getWaveValue() [2/3]

double FFaFunctionManager::getWaveValue	(	const IntVec &	intVars,
		const RealVec &	realVars,
		const double	g,
		const double	d,
		const FaVec3 &	x,
		const double	t,
		int	iop = `0`
	)

Evaluates a wave profile function.

Parameters

[in]	intVars	Integer wave function parameters
[in]	realVars	Real wave function parameters
[in]	g	Gravity constant
[in]	d	Water depth
[in]	x	Position to evaluate wave profile at
[in]	t	Time to evaluate wave profile at
[in]	iop	Wave model option

Returns: Wave elevation

See also: The fortran routine waveprofile().

◆ getWaveValue() [3/3]

double FFaFunctionManager::getWaveValue	(	const RealVec &	realVars,
		const double	g,
		const double	d,
		const FaVec3 &	x,
		const double	t,
		int	iop = `0`
	)

Evaluates a wave profile function.

Parameters

[in]	realVars	Real wave function parameters
[in]	g	Gravity constant
[in]	d	Water depth
[in]	x	Position to evaluate wave profile at
[in]	t	Time to evaluate wave profile at
[in]	iop	Wave model option

Returns: Wave elevation

See also: The fortran routine waveprofile().

◆ initWaveFunction() [1/4]

bool FFaFunctionManager::initWaveFunction	(	const int	iop,
		const double	g,
		double	d,
		RealVec &	realVars
	)

Initializes parameters for a non-linear wave function.

Parameters

[in]	iop	Wave model option
[in]	g	Gravity constant
[in]	d	Water depth
[out]	realVars	Real wave function parameters

See also: The fortran routine initnonlinwavefunc().

◆ initWaveFunction() [2/4]

bool FFaFunctionManager::initWaveFunction	(	const int	iop,
		const int	nWave,
		const int	nDir,
		const int	sprExp,
		const int	rSeed,
		RealVec &	realVars
	)

Initializes parameters for a wave function from a wave spectrum.

Parameters

[in]	iop	Wave spectrum model
[in]	nWave	Number of wave components to generate
[in]	nDir	Number of wave directions
[in]	sprExp	Wave spreading exponent
[in]	rSeed	Seed for (pseudo-)random phase shift
[out]	realVars	Real wave function parameters

See also: The fortran routine initwavefuncspectrum().

◆ initWaveFunction() [3/4]

bool FFaFunctionManager::initWaveFunction	(	const int	iop,
		const int	nWave,
		const int	rSeed,
		const double	g,
		const double	d,
		IntVec &	intVars,
		RealVec &	realVars
	)

Initializes parameters for an embedded non-linear wave function.

Parameters

[in]	iop	Wave model option
[in]	nWave	Number of wave components
[in]	rSeed	Seed for (pseudo-)random phase shift
[in]	g	Gravity constant
[in]	d	Water depth
[out]	intVars	Integer wave function parameters
[out]	realVars	Real wave function parameters

See also: The fortran routine initembeddedwave().

◆ initWaveFunction() [4/4]

bool FFaFunctionManager::initWaveFunction	(	const std::string &	fileName,
		const int	nWave,
		const int	rSeed,
		RealVec &	realVars
	)

Initializes parameters for a wave function from given file.

Parameters

[in]	fileName	Name of file to read parameters from
[in]	nWave	Number of wave components to read
[in]	rSeed	Seed for (pseudo-)random phase shift
[out]	realVars	Real wave function parameters

See also: The fortran routine initwavefuncfromfile().

Typedefs

Functions

Detailed Description

Typedef Documentation

◆ IntVec

◆ RealVec

Function Documentation

◆ getDerivative()

◆ getSmartPoints()

◆ getTypeID()

◆ getValue() [1/2]

◆ getValue() [2/2]

◆ getWaveValue() [1/3]

◆ getWaveValue() [2/3]

◆ getWaveValue() [3/3]

◆ initWaveFunction() [1/4]

◆ initWaveFunction() [2/4]

◆ initWaveFunction() [3/4]

◆ initWaveFunction() [4/4]