Set options for CalcFiniteDiffProd from an OptionsFromStream object. More...

#include <NLPInterfacePack_CalcFiniteDiffProdSetOptions.hpp>

Inheritance diagram for NLPInterfacePack::CalcFiniteDiffProdSetOptions:

Public Member Functions
	CalcFiniteDiffProdSetOptions (CalcFiniteDiffProd *target=0, const char opt_grp_name[]="CalcFiniteDiffProd")

Public Member Functions inherited from OptionsFromStreamPack::SetOptionsFromStreamNode
	SetOptionsFromStreamNode (const std::string &options_group, int num_options, const char *option_names[], bool exists_optional=true)
	Constructs with the name of the options group and the names of the options. More...

void	set_options (const OptionsFromStream &options)
	Overridden from SetOptionsFromStream and calls setOption(...). More...

Public Member Functions inherited from OptionsFromStreamPack::SetOptionsFromStream
virtual	~SetOptionsFromStream ()

Public Member Functions inherited from OptionsFromStreamPack::SetOptionsToTargetBase< CalcFiniteDiffProd >
	SetOptionsToTargetBase (CalcFiniteDiffProd *target=0)

void	set_target (CalcFiniteDiffProd *target)

CalcFiniteDiffProd *	get_target ()

const CalcFiniteDiffProd *	get_target () const

CalcFiniteDiffProd &	target ()

const CalcFiniteDiffProd &	target () const

Protected Member Functions
void	setOption (int option_num, const std::string &option_value)
	Overridden from SetOptionsFromStreamNode. More...

Detailed Description

Set options for CalcFiniteDiffProd from an OptionsFromStream object.

The default options group name is CalcFiniteDiffProd.

The options group is:

options_group CalcFiniteDiffProdSetOptions {
*    fd_method_order = FD_ORDER_ONE;
*    fd_method_order = FD_ORDER_TWO;
*    fd_method_order = FD_ORDER_TWO_CENTRAL;
*    fd_method_order = FD_ORDER_TWO_AUTO;
*    fd_method_order = FD_ORDER_FOUR;
*    fd_method_order = FD_ORDER_FOUR_CENTRAL;
*    fd_method_order = FD_ORDER_FOUR_AUTO; *** (Default)
*    fd_step_select = FD_STEP_ABSOLUTE; *** (Default)
*    fd_step_select = FD_STEP_RELATIVE;
*    fd_step_size = -1.0; *** (default)
*    fd_step_size_min = -1.0; *** (default)
*    fd_step_size_f = -1.0; *** (default)
*    fd_step_size_c = -1.0; *** (default)
}

Definition at line 76 of file NLPInterfacePack_CalcFiniteDiffProdSetOptions.hpp.

Constructor & Destructor Documentation

NLPInterfacePack::CalcFiniteDiffProdSetOptions::CalcFiniteDiffProdSetOptions	(	CalcFiniteDiffProd *	target = `0`,
		const char	opt_grp_name[] = `"CalcFiniteDiffProd"`
	)

Definition at line 75 of file NLPInterfacePack_CalcFiniteDiffProdSetOptions.cpp.

Member Function Documentation

void NLPInterfacePack::CalcFiniteDiffProdSetOptions::setOption	(	int	option_num,
		const std::string &	option_value
	)

protectedvirtual

Overridden from SetOptionsFromStreamNode.

Implements OptionsFromStreamPack::SetOptionsFromStreamNode.

Definition at line 83 of file NLPInterfacePack_CalcFiniteDiffProdSetOptions.cpp.

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

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation