FIMS  v0.8.0
Loading...
Searching...
No Matches
fims_popdy::GrowthBase< Type > Struct Template Referenceabstract

Base class for all growth functors. More...

#include <growth_base.hpp>

Inheritance diagram for fims_popdy::GrowthBase< Type >:
fims_model_object::FIMSObject< Type > fims_popdy::EWAAGrowth< Type >

Public Member Functions

 GrowthBase ()
 Constructor.
 
virtual const Type evaluate (const double &a)=0
 Calculates the growth at the independent variable value.
 
- Public Member Functions inherited from fims_model_object::FIMSObject< Type >
uint32_t GetId () const
 Getter that returns the unique id for parameters in the model.
 
bool CheckDimensions (size_t actual, size_t expected)
 Check the dimensions of an object.
 
virtual void create_report_vectors (std::map< std::string, fims::Vector< fims::Vector< Type > > > &report_vectors)
 Create a map of report vectors for the object. used to populate the report_vectors map in FisheryModelBase.
 
virtual void get_report_vector_count (std::map< std::string, size_t > &report_vector_count)
 Get the report vector count object. used to get the length of each report vector for populating the UncertaintyReportInfo struct in FisheryModelBase.
 

Static Public Attributes

static uint32_t id_g = 0
 

Additional Inherited Members

- Public Attributes inherited from fims_model_object::FIMSObject< Type >
uint32_t id
 
std::vector< Type * > parameters
 
std::vector< Type * > random_effects_parameters
 
std::vector< Type * > fixed_effects_parameters
 

Detailed Description

template<typename Type>
struct fims_popdy::GrowthBase< Type >

Base class for all growth functors.

Template Parameters
TypeThe type of the growth functor.

Member Function Documentation

◆ evaluate()

template<typename Type >
virtual const Type fims_popdy::GrowthBase< Type >::evaluate ( const double a)
pure virtual

Calculates the growth at the independent variable value.

Parameters
aThe age at which to return weight of the fish (in kg).

Implemented in fims_popdy::EWAAGrowth< Type >.

Member Data Documentation

◆ id_g

template<typename Type >
uint32_t fims_popdy::GrowthBase< Type >::id_g = 0
static

reference id for growth object


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