environmentmodels::CNetCDFField Class Reference

#include <NetCDFField.h>

Inheritance diagram for environmentmodels::CNetCDFField:

Collaboration diagram for environmentmodels::CNetCDFField:

Public Member Functions
	CNetCDFField (string sSimObjectName, ISimObjectCreator *pCreator)
void	OdeFcn (const double T, const double *const X, double *const XDot, const bool bIsMajorTimeStep)
void	GetDomainBounds (double *Bound)
void	GetFieldData (const double dT, const double *const dX, const double Pos[3], double *DataOut)

Protected Attributes
NetcdfHandler *	m_NetCDF
	NetCDF handler for data I/O. Protected to allow subclass access.
float	m_Bounds [6]
	Domain bounds [xmin, xmax, ymin, ymax, zmin, zmax] [m]. Protected to allow subclass access.

Detailed Description

NetCDF field implementation.

Loads field data from NetCDF files and provides GetFieldData() for bilinear/trilinear interpolation at query positions.

Constructor & Destructor Documentation

CNetCDFField()

environmentmodels::CNetCDFField::CNetCDFField	(	string	sSimObjectName,
		ISimObjectCreator *	pCreator
	)

Construct NetCDF field.

Parameters

[in]	sSimObjectName	Unique name for this simulation object.
[in]	pCreator	Pointer to the object creator/registry.

Member Function Documentation

GetDomainBounds()

void environmentmodels::CNetCDFField::GetDomainBounds

(

double *

Bound

)

Get domain bounds.

Parameters

[out]

Bound

Array of at least 6 doubles [xmin, xmax, ymin, ymax, zmin, zmax].

GetFieldData()

void environmentmodels::CNetCDFField::GetFieldData	(	const double	dT,
		const double *const	dX,
		const double	Pos[3],
		double *	DataOut
	)

Get interpolated field data at a position.

Parameters

[in]	dT	Current simulation time.
[in]	dX	Current state vector.
[in]	Pos	Query position [x, y, z].
[out]	DataOut	Interpolated field values.

OdeFcn()

void environmentmodels::CNetCDFField::OdeFcn	(	const double	T,
		const double *const	X,
		double *const	XDot,
		const bool	bIsMajorTimeStep
	)

ODE function for state updates.

Parameters

[in]	T	Current simulation time.
[in]	X	Current state vector.
[out]	XDot	State derivative vector.
[in]	bIsMajorTimeStep	True if this is a major timestep.

---

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

• /update_root/webfhsim/reloadrepos/fhsim_environment/src/environment/NetCDFField.h