Class for nodes that live on spines. The assumption is that each Node lies at a fixed fraction on a single spine (although more complex behaviour could be included by adding more variables to the spine). In general, more complex node updating should be handled by the classes implemented for algebraic node updates. More...

#include <spines.h>

Inheritance diagram for oomph::SpineNode:

Public Member Functions
	SpineNode (const unsigned &n_dim, const unsigned &n_position_type, const unsigned &initial_nvalue)
	Steady Constructor, initialise pointers to zero. More...

	SpineNode (TimeStepper *const &time_stepper_pt, const unsigned &n_dim, const unsigned &n_position_type, const unsigned &initial_nvalue)
	Unsteady Constructor, initialise pointers to zero. More...

Spine *&	spine_pt ()
	Access function to spine. More...

double &	fraction ()
	Set reference to fraction along spine. More...

unsigned &	node_update_fct_id ()
	Access function to ID of node update function (within specific mesh) More...

SpineMesh *&	spine_mesh_pt ()
	Access function to Pointer to SpineMesh that this node is a part of and which implements the node update function(s) More...

double &	h ()
	Access function to spine height. More...

void	node_update (const bool &update_all_time_levels_for_new_node=false)
	Overload thet node update function, call the update function in the Node's SpineMesh. More...

unsigned	ngeom_data () const
	Return the number of geometric data, zero if no spine. More...

unsigned	ngeom_object () const
	Return the number of geometric objects, zero if no spine. More...

Data **	all_geom_data_pt ()
	Return the vector of all geometric data. More...

GeomObject **	all_geom_object_pt ()
	Return the vector of all geometric objects. More...

Public Member Functions inherited from oomph::Node
	Node ()
	Default constructor. More...

	Node (const unsigned &n_dim, const unsigned &n_position_type, const unsigned &initial_n_value, const bool &allocate_x_position=true)
	Steady constructor, for a Node of spatial dimension n_dim. Allocates storage for initial_n_value values. NPosition_type is the number of coordinate types needed in the mapping between local and global coordinates (e.g. 1 for Lagrange-type elements; 2 for 1D Hermite elements; 4 for 2D Hermite elements, etc). More...

	Node (TimeStepper *const &time_stepper_pt, const unsigned &n_dim, const unsigned &n_position_type, const unsigned &initial_n_value, const bool &allocate_x_position=true)
	Unsteady constructor for a node of spatial dimension n_dim. Allocates storage for initial_n_value values with history values as required by the timestepper. n_position_type: # of coordinate types needed in the mapping between local and global coordinates (e.g. 1 for Lagrange-type elements; 2 for 1D Hermite elements; 4 for 2D Hermite elements). More...

virtual	~Node ()
	Destructor: Clean up the memory allocated for nodal position. More...

	Node (const Node &node)=delete
	Broken copy constructor. More...

void	operator= (const Node &)=delete
	Broken assignment operator. More...

unsigned	nposition_type () const
	Number of coordinate types needed in the mapping between local and global coordinates. More...

TimeStepper *&	position_time_stepper_pt ()
	Return a pointer to the position timestepper. More...

TimeStepper *const &	position_time_stepper_pt () const
	Return a pointer to the position timestepper (const version). More...

virtual void	set_position_time_stepper (TimeStepper *const &position_time_stepper_pt, const bool &preserve_existing_data)
	Set a new position timestepper be resizing the appropriate storage. More...

virtual bool	does_pointer_correspond_to_position_data (double *const &parameter_pt)
	Check whether the pointer parameter_pt addresses position data values. It never does for a standard node, because the positions are not data. More...

virtual void	assign_eqn_numbers (unsigned long &global_ndof, Vector< double * > &dof_pt)
	Assign global equation numbers; increment global number of unknowns, global_ndof; and add any new dofs to the dof_pt. More...

unsigned	ndim () const
	Return (Eulerian) spatial dimension of the node. More...

double &	x (const unsigned &i)
	Return the i-th nodal coordinate. More...

const double &	x (const unsigned &i) const
	Return the i-th nodal coordinate (const version). More...

double &	x (const unsigned &t, const unsigned &i)
	Return the position x(i) at previous timestep t (t=0: present; t>0 previous timestep). More...

const double &	x (const unsigned &t, const unsigned &i) const
	Return the position x(i) at previous timestep t (t=0: present; t>0 previous timestep) (const version) More...

double	dx_dt (const unsigned &i) const
	Return the i-th component of nodal velocity: dx/dt. More...

double	dx_dt (const unsigned &j, const unsigned &i) const
	Return the i-th component of j-th derivative of nodal position: d^jx/dt^j. More...

virtual Node *	copied_node_pt () const
	Return pointer to copied node (null if the current node is not a copy – always the case here; it's overloaded for boundary nodes) More...

virtual bool	position_is_a_copy () const
	Return whether any position coordinate has been copied (always false) More...

virtual bool	position_is_a_copy (const unsigned &i) const
	Return whether the position coordinate i has been copied (always false) More...

double &	x_gen (const unsigned &k, const unsigned &i)
	Reference to the generalised position x(k,i). ‘Type’: k; Coordinate direction: i. More...

const double &	x_gen (const unsigned &k, const unsigned &i) const
	Reference to the generalised position x(k,i). ‘Type’: k; Coordinate direction: i (const version). More...

double &	x_gen (const unsigned &t, const unsigned &k, const unsigned &i)
	Reference to the generalised position x(k,i) at the previous timestep [t=0: present]. ‘Type’: k; Coordinate direction: i. More...

const double &	x_gen (const unsigned &t, const unsigned &k, const unsigned &i) const
	Reference to the generalised position x(k,i) at the previous timestep [t=0: present]. ‘Type’: k; Coordinate direction: i. (const version) More...

double	dx_gen_dt (const unsigned &k, const unsigned &i) const
	i-th component of time derivative (velocity) of the generalised position, dx(k,i)/dt. ‘Type’: k; Coordinate direction: i. More...

double	dx_gen_dt (const unsigned &j, const unsigned &k, const unsigned &i) const
	i-th component of j-th time derivative (velocity) of the generalised position, d^jx(k,i)/dt^j. ‘Type’: k; Coordinate direction: i. More...

double *	x_pt (const unsigned &t, const unsigned &i)
	Direct access to the i-th coordinate at time level t (t=0: present; t>0: previous) More...

void	copy (Node *orig_node_pt)
	Copy all nodal data from specified Node object. More...

virtual void	dump (std::ostream &dump_file) const
	Dump nodal position and associated data to file for restart. More...

void	read (std::ifstream &restart_file)
	Read nodal position and associated data from file for restart. More...

virtual void	pin_all ()
	The pin_all() function must be overloaded by SolidNodes, so we put the virtual interface here to avoid virtual functions in Data. More...

virtual void	unpin_all ()
	The unpin_all() function must be overloaded by SolidNode, so we put the virtual interface here to avoid virtual functions in Data. More...

unsigned	hang_code ()
	Code that encapsulates the hanging status of the node (incl. the geometric hanging status) as $\sum_{i=-1}{nval-1} Node::is_hanging(i) 2^{i+1}$ . More...

HangInfo *const &	hanging_pt () const
	Return pointer to hanging node data (this refers to the geometric hanging node status) (const version). More...

HangInfo *const &	hanging_pt (const int &i) const
	Return pointer to hanging node data for value i (const version) More...

bool	is_hanging () const
	Test whether the node is geometrically hanging. More...

bool	is_hanging (const int &i) const
	Test whether the i-th value is hanging. More...

void	set_hanging_pt (HangInfo *const &hang_pt, const int &i)
	Set the hanging data for the i-th value. (hang_pt=0 to make non-hanging) More...

void	set_nonhanging ()
	Label node as non-hanging node by removing all hanging node data. More...

void	resize (const unsigned &n_value)
	Resize the number of equations. More...

virtual void	constrain_positions ()
	Constrain the positions when the node is made hanging Empty virtual function that is overloaded in SolidNodes. More...

virtual void	unconstrain_positions ()
	Unconstrain the positions when the node is made non-hanging Empty virtual function that is overloaded in SolidNodes. More...

virtual void	make_periodic (Node *const &node_pt)
	Make the node periodic by copying the values from node_pt. Note that the coordinates will always remain independent, even though this may lead to (a little) unrequired information being stored. Broken virtual (only implemented in BoundaryNodes) More...

virtual void	make_periodic_nodes (const Vector< Node * > &periodic_nodes_pt)
	Make the nodes passed in the vector periodic_nodes share the same data as this node. More...

virtual void	get_boundaries_pt (std::set< unsigned > *&boundaries_pt)
	Return a pointer to set of mesh boundaries that this node occupies; this will be overloaded by BoundaryNodes. The default behaviour is that the Node does not lie on any boundaries so the pointer to the set of boundaries is NULL. More...

virtual bool	is_on_boundary () const
	Test whether the Node lies on a boundary. The "bulk" Node cannot lie on a boundary, so return false. This will be overloaded by BoundaryNodes. More...

virtual bool	is_on_boundary (const unsigned &b) const
	Test whether the node lies on mesh boundary b. The "bulk" Node cannot lie on a boundary, so return false. This will be overloaded by BoundaryNodes. More...

virtual void	add_to_boundary (const unsigned &b)
	Broken interface for adding the node to the mesh boundary b Essentially here for error reporting. More...

virtual void	remove_from_boundary (const unsigned &b)
	Broken interface for removing the node from the mesh boundary b Here to provide error reporting. More...

virtual unsigned	ncoordinates_on_boundary (const unsigned &b)
	Get the number of boundary coordinates on mesh boundary b. Broken virtual interface provides run-time error checking. More...

virtual bool	boundary_coordinates_have_been_set_up ()
	Have boundary coordinates been set up? Broken virtual interface provides run-time error checking. More...

virtual void	get_coordinates_on_boundary (const unsigned &b, const unsigned &k, Vector< double > &boundary_zeta)
	Return the vector of the k-th generalised boundary coordinates on mesh boundary b. Broken virtual interface provides run-time error checking. More...

virtual void	set_coordinates_on_boundary (const unsigned &b, const unsigned &k, const Vector< double > &boundary_zeta)
	Set the vector of the k-th generalised boundary coordinates on mesh boundary b. Broken virtual interface provides run-time error checking. More...

virtual void	get_coordinates_on_boundary (const unsigned &b, Vector< double > &boundary_zeta)
	Return the vector of coordinates on mesh boundary b Broken virtual interface provides run-time error checking. More...

virtual void	set_coordinates_on_boundary (const unsigned &b, const Vector< double > &boundary_zeta)
	Set the vector of coordinates on mesh boundary b Broken virtual interface provides run-time error checking. More...

void	set_obsolete ()
	Mark node as obsolete. More...

void	set_non_obsolete ()
	Mark node as non-obsolete. More...

bool	is_obsolete ()
	Test whether node is obsolete. More...

double	raw_value (const unsigned &i) const
	Return the i-th value stored at the Node. This interface does NOT take the hanging status of the Node into account. More...

double	raw_value (const unsigned &t, const unsigned &i) const
	Return the i-th value at time level t (t=0: present, t>0: previous). This interface does NOT take the hanging status of the Node into account. More...

double	value (const unsigned &i) const
	Return i-th value (dofs or pinned) at this node either directly or via hanging node representation. Note that this REDFINES the interface in Data Thus, the present function will be called provided that it is accessed through a pointer to a node i.e. Node* node_pt->value() will take hanging information into account. If a pointer to a Node has been explicitly down-cast to a pointer to Data then the "wrong" (Data) version of the function will be called. More...

double	value (const unsigned &t, const unsigned &i) const
	Return i-th value at time level t (t=0: present, t>0: previous) either directly or via hanging node representation. Note that this REDEFINES the interface in Data Thus, the present function will be called provided that it is accessed through a pointer to a node i.e. Node* node_pt->value() will take hanging information into account. If a pointer to a Node has been explicitly down-cast to a pointer to Data then the "wrong" (Data) version of the function will be called. More...

void	value (Vector< double > &values) const
	Compute Vector of values for the Data value taking the hanging node status into account. Note that this REDEFINES the interface in Data Thus, the present function will be called provided that it is accessed through a pointer to a node i.e. Node* node_pt->value() will take hanging information into account. If a pointer to a Node has been explicitly down-cast to a pointer to Data then the "wrong" (Data) version of the function will be called. More...

Vector< double >	value () const
	Return vector of values calculated using value(vector). More...

void	value (const unsigned &t, Vector< double > &values) const
	Compute Vector of values (dofs or pinned) in this data at time level t (t=0: present; t>0: previous). This interface explicitly takes the hanging status into account. Thus, the present function will be called provided that it is accessed through a pointer to a node i.e. Node* node_pt->value() will take hanging information into account. If a pointer to a Node has been explicitly down-cast to a pointer to Data then the "wrong" (Data) version of the function will be called. More...

void	position (Vector< double > &pos) const
	Compute Vector of nodal positions either directly or via hanging node representation. More...

Vector< double >	position () const
	Return vector of position of node at current time. More...

void	position (const unsigned &t, Vector< double > &pos) const
	Compute Vector of nodal position at time level t (t=0: current; t>0: previous timestep), either directly or via hanging node representation. More...

double	position (const unsigned &i) const
	Return i-th nodal coordinate either directly or via hanging node representation. More...

double	position (const unsigned &t, const unsigned &i) const
	Return i-th nodal coordinate at time level t (t=0: current; t>0: previous time level), either directly or via hanging node representation. More...

double	position_gen (const unsigned &k, const unsigned &i) const
	Return generalised nodal coordinate either directly or via hanging node representation. More...

double	position_gen (const unsigned &t, const unsigned &k, const unsigned &i) const
	Return generalised nodal coordinate at time level t (t=0: current; t>0: previous time level), either directly or via hanging node representation. More...

double	dposition_dt (const unsigned &i) const
	Return the i-th component of nodal velocity: dx/dt, either directly or via hanging node representation. More...

double	dposition_dt (const unsigned &j, const unsigned &i) const
	Return the i-th component of j-th derivative of nodal position: d^jx/dt^j either directly or via hanging node representation. More...

double	dposition_gen_dt (const unsigned &k, const unsigned &i) const
	i-th component of time derivative (velocity) of the generalised position, dx(k,i)/dt. ‘Type’: k; Coordinate direction: i. This function uses the hanging node representation if necessary. More...

double	dposition_gen_dt (const unsigned &j, const unsigned &k, const unsigned &i) const
	i-th component of j-th time derivative (velocity) of the generalised position, d^jx(k,i)/dt^j. ‘Type’: k; Coordinate direction: i. This function uses the hanging node representation if necessary More...

void	set_auxiliary_node_update_fct_pt (AuxNodeUpdateFctPt aux_node_update_fct_pt)
	Set pointer to auxiliary update function – this can be used to update any nodal values following the update of the nodal position. This is needed e.g. to update the no-slip condition on moving boundaries. More...

bool	has_auxiliary_node_update_fct_pt ()
	Boolean to indicate if node has a pointer to and auxiliary update function. More...

void	perform_auxiliary_node_update_fct ()
	Execute auxiliary update function (if any) – this can be used to update any nodal values following the update of the nodal position. This is needed e.g. to update the no-slip condition on moving boundaries. More...

void	output (std::ostream &outfile)
	Output nodal position. More...

void	add_values_to_vector (Vector< double > &vector_of_values)
	Add all data and time history values to the vector. Overloaded to add the position information as well. More...

void	read_values_from_vector (const Vector< double > &vector_of_values, unsigned &index)
	Read all data and time history values from the vector starting from index. On return the index will be set the value at the end of the data that has been read in Overload to also read the position information. More...

Public Member Functions inherited from oomph::Data
virtual void	clear_copied_pointers ()
	Helper function that should be overloaded derived classes that contain copies of data. The function must unset (NULL out) the internal pointers to the copied data. This is used when destructing data to ensure that all pointers remain valid. The default implementation throws an error because Data cannot be a copy. More...

	Data ()
	Default: Just set pointer to (steady) timestepper. No storage for values is allocated. More...

	Data (const unsigned &initial_n_value)
	Default constructor for steady problems: assign memory for initial_n_value values. More...

	Data (TimeStepper *const &time_stepper_pt, const unsigned &initial_n_value, const bool &allocate_storage=true)
	Constructor for unsteady problems: assign memory for initial_n_value values and any memory required by the Timestepper for the storage of history values. More...

	Data (const Data &data)=delete
	Broken copy constructor. More...

void	operator= (const Data &)=delete
	Broken assignment operator. More...

virtual	~Data ()
	Destructor, deallocates memory assigned for data. More...

void	set_time_stepper (TimeStepper *const &time_stepper_pt, const bool &preserve_existing_data)
	Set a new timestepper by resizing the appropriate storage. If already assigned the equation numbering will not be altered. More...

TimeStepper *&	time_stepper_pt ()
	Return the pointer to the timestepper. More...

TimeStepper *const &	time_stepper_pt () const
	Return the pointer to the timestepper (const version). More...

virtual bool	is_a_copy () const
	Return a boolean to indicate whether the Data objact contains any copied values. A base Data object can never be a copy so the default implementation always returns false. More...

virtual bool	is_a_copy (const unsigned &i) const
	Return flag to indicate whether the i-th value is a copy. A base Data object can never be a copy so the default implementation always returns false. More...

void	set_value (const unsigned &i, const double &value_)
	Set the i-th stored data value to specified value. The only reason that we require an explicit set function is because we redefine value() in the Node class to interpolate the values for nodes that are hanging and so we cannot return a reference to the value in this case. More...

void	set_value (const unsigned &t, const unsigned &i, const double &value_)
	Set the t-th history value of the i-th stored data value to specified value. More...

double	value (const unsigned &i) const
	Return i-th stored value. This function is not virtual so that it can be inlined. This means that if we have an explicit pointer to a Data object Data* data_pt->value() always returns the "raw" stored value. More...

double	value (const unsigned &t, const unsigned &i) const
	Return i-th value at time level t (t=0: present, t>0: previous) This function is not virtual so that it can be inlined. This means that if we have an explicit pointer to a Data object Data* data_pt->value() always returns to the "raw" stored value. More...

void	value (Vector< double > &values) const
	Compute Vector of values for the Data value. More...

void	value (const unsigned &t, Vector< double > &values) const
	Compute Vector of values (dofs or pinned) in this data at time level t (t=0: present; t>0: previous). More...

double *	value_pt (const unsigned &i) const
	Return the pointer to the i-the stored value. Typically this is required when direct access to the stored value is required, e.g. when writing functions that return a reference to a variable that is stored in a Data object. More...

double *	value_pt (const unsigned &t, const unsigned &i) const
	Return the pointer to the i-th stored value, or any of its history values (const version). Typically this is required when direct access to the stored value is required, e.g. when writing functions that return a reference to a variable that is stored in a Data object. More...

bool	does_pointer_correspond_to_value (double *const &parameter_pt)
	Check whether the pointer parameter_pt addresses internal data values. More...

void	copy (Data *orig_data_pt)
	Copy Data values from specified Data object. More...

void	dump (std::ostream &dump_file) const
	Dump the data object to a file. More...

void	read (std::ifstream &restart_file)
	Read data object from a file. More...

long *	eqn_number_pt (const unsigned &i)
	Return the pointer to the equation number of the i-th stored variable. More...

long &	eqn_number (const unsigned &i)
	Return the equation number of the i-th stored variable. More...

long	eqn_number (const unsigned &i) const
	Return the equation number of the i-th stored variable. More...

void	pin (const unsigned &i)
	Pin the i-th stored variable. More...

void	unpin (const unsigned &i)
	Unpin the i-th stored variable. More...

void	pin_all ()
	Pin all the stored variables. More...

void	unpin_all ()
	Unpin all the stored variables. More...

bool	is_pinned (const unsigned &i) const
	Test whether the i-th variable is pinned (1: true; 0: false). More...

bool	is_segregated_solve_pinned (const unsigned &i)
	Test whether the i-th variable is temporaily pinned for a segregated solve. More...

void	constrain (const unsigned &i)
	Constrain the i-th stored variable when making hanging data If the data is already pinned leave it along, otherwise mark as constrained (hanging) More...

void	unconstrain (const unsigned &i)
	Unconstrain the i-th stored variable when make the data nonhanging. Only unconstrain if it was actually constrained (hanging) More...

void	constrain_all ()
	Constrain all the stored variables when the data is made hanging. More...

void	unconstrain_all ()
	Unconstrain all the stored variables when the data is made nonhanging. More...

bool	is_constrained (const unsigned &i)
	Test whether the i-th variable is constrained (1: true; 0: false). More...

unsigned	self_test ()
	Self-test: Have all values been classified as pinned/unpinned? Return 0 if OK. More...

unsigned	nvalue () const
	Return number of values stored in data object (incl pinned ones). More...

unsigned	ntstorage () const
	Return total number of doubles stored per value to record time history of each value (one for steady problems). More...

virtual void	describe_dofs (std::ostream &out, const std::string &current_string) const
	Function to describe the dofs of the Node. The ostream specifies the output stream to which the description is written; the string stores the currently assembled output that is ultimately written to the output stream by Data::describe_dofs(...); it is typically built up incrementally as we descend through the call hierarchy of this function when called from Problem::describe_dofs(...) More...

virtual void	add_value_pt_to_map (std::map< unsigned, double * > &map_of_value_pt)
	Add pointers to all unpinned and unconstrained data to a map indexed by (global) equation number. More...

void	set_halo (const unsigned &non_halo_proc_ID)
	Label the node as halo and specify processor that holds non-halo counterpart. More...

void	set_nonhalo ()
	Label the node as not being a halo. More...

bool	is_halo () const
	Is this Data a halo? More...

int	non_halo_proc_ID ()
	ID of processor ID that holds non-halo counterpart of halo node; negative if not a halo. More...

virtual void	add_eqn_numbers_to_vector (Vector< long > &vector_of_eqn_numbers)
	Add all equation numbers to the vector in the internal storage order. More...

virtual void	read_eqn_numbers_from_vector (const Vector< long > &vector_of_eqn_numbers, unsigned &index)
	Read all equation numbers from the vector starting from index. On return the index will be set to the value at the end of the data that has been read in. More...

Private Attributes
Spine *	Spine_pt
	Private internal data pointer to a spine. More...

double	Fraction
	Private double that represents the fixed fraction along the spine. More...

SpineMesh *	Spine_mesh_pt
	Pointer to SpineMesh that this node is a part of. (The mesh implements the node update function(s)) More...

unsigned	Node_update_fct_id
	ID of node update function (within specific mesh – useful if there are multiple node update functions, e.g. in two-layer problems. More...

Additional Inherited Members
Public Types inherited from oomph::Node
typedef void(*	AuxNodeUpdateFctPt) (Node *)
	Function pointer to auxiliary node update function. More...

Static Public Attributes inherited from oomph::Node
static unsigned	No_independent_position = 10
	Static "Magic number" used to indicate that there is no independent position in a periodic node. More...

Static Public Attributes inherited from oomph::Data
static long	Is_pinned = -1
	Static "Magic number" used in place of the equation number to indicate that the value is pinned. More...

static long	Is_segregated_solve_pinned = -3
	Static "Magic number" used in place of the equation number to indicate that the value is pinned, but only for the duration of a segregated solve. More...

static long	Is_unclassified = -10
	Static "Magic number" used in place of the equation number to denote a value that hasn't been classified as pinned or free. More...

static long	Is_constrained = -2
	Static "Magic number" used in place of the equation number to indicate that the value is constrained because it is associated with non-conforming element boundaries — a hanging node — (and is therefore pinned) More...

Protected Member Functions inherited from oomph::Node
void	x_gen_range_check (const unsigned &t, const unsigned &k, const unsigned &i) const
	Private function to check that the arguemnts to the position functions are in range. More...

double *	x_position_pt (const unsigned &i)
	Direct access to the pointer to the i-th stored coordinate data. More...

Protected Member Functions inherited from oomph::Data
virtual void	reset_copied_pointers ()
	Helper function that should be overloaded in derived classes that can contain copies of Data. The function must reset the internal pointers to the copied data. This is used when resizing data to ensure that all the pointers remain valid. The default implementation throws an error beacause Data cannot be a copy. More...

Protected Attributes inherited from oomph::Node
double **	X_position
	Array of pointers to the data holding the Eulerian positions. The storage format must be the same as the internal data storage so that we can implement the functions x() in generality here without the need for virtual functions. The first index will be a flat array of position types and coordinates and the second will be the number of time history values at each position type. More...

TimeStepper *	Position_time_stepper_pt
	Pointer to the timestepper associated with the position data. More...

HangInfo **	Hanging_pt
	C-style array of pointers to hanging node info. It's set to NULL if the node isn't hanging. The first entry (0) is the geometric hanging node data. The remaining entries correspond to the hanging data for the other values stored at the node. Usually, these entries will be the same as the geometric hanging node data represented by Hanging_pt[0], but this is not necessarily the case; e.g. the pressure in Taylor Hood has different hanging node data from the velocities. More...

unsigned	Ndim
	Eulerian dimension of the node. More...

unsigned	Nposition_type
	Number of coordinate types used in the mapping between local and global coordinates (e.g. 1 for Lagrange-type elements; 2 for 1D Hermite elements; 4 for 2D Hermite elements, etc). More...

bool	Obsolete
	Flag to indicate that the Node has become obsolete — usually during mesh refinement process. More...

AuxNodeUpdateFctPt	Aux_node_update_fct_pt
	Pointer to auxiliary update function – this can be used to update any nodal values following the update of the nodal position. This is needed e.g. to update the no-slip condition on moving boundaries. More...

Protected Attributes inherited from oomph::Data
Data **	Copy_of_data_pt
	C-style array of any Data objects that contain copies of the current Data object's data values. More...

unsigned	Ncopies
	Number of Data that contain copies of this Data object's values. More...

Static Protected Attributes inherited from oomph::Data
static TimeStepper *	Default_static_time_stepper_pt = new Steady<0>()
	Default (static) timestepper used in steady problems. More...

Detailed Description

Class for nodes that live on spines. The assumption is that each Node lies at a fixed fraction on a single spine (although more complex behaviour could be included by adding more variables to the spine). In general, more complex node updating should be handled by the classes implemented for algebraic node updates.

Definition at line 327 of file spines.h.

Constructor & Destructor Documentation

◆ SpineNode() [1/2]

oomph::SpineNode::SpineNode	(	const unsigned &	n_dim,
		const unsigned &	n_position_type,
		const unsigned &	initial_nvalue
	)

inline

Steady Constructor, initialise pointers to zero.

Definition at line 347 of file spines.h.

◆ SpineNode() [2/2]

oomph::SpineNode::SpineNode	(	TimeStepper *const &	time_stepper_pt,
		const unsigned &	n_dim,
		const unsigned &	n_position_type,
		const unsigned &	initial_nvalue
	)

inline

Unsteady Constructor, initialise pointers to zero.

Definition at line 359 of file spines.h.

Member Function Documentation

◆ all_geom_data_pt()

Data** oomph::SpineNode::all_geom_data_pt ( )

inlinevirtual

Return the vector of all geometric data.

Reimplemented from oomph::Node.

Definition at line 433 of file spines.h.

References oomph::Spine::geom_data_pt(), and Spine_pt.

◆ all_geom_object_pt()

GeomObject** oomph::SpineNode::all_geom_object_pt ( )

inlinevirtual

Return the vector of all geometric objects.

Reimplemented from oomph::Node.

Definition at line 439 of file spines.h.

References oomph::Spine::geom_object_pt(), and Spine_pt.

◆ fraction()

double& oomph::SpineNode::fraction ( )

inline

Set reference to fraction along spine.

Definition at line 378 of file spines.h.

References Fraction.

◆ h()

double& oomph::SpineNode::h ( )

inline

Access function to spine height.

Definition at line 397 of file spines.h.

References oomph::Spine::height(), and Spine_pt.

◆ ngeom_data()

unsigned oomph::SpineNode::ngeom_data ( ) const

inlinevirtual

Return the number of geometric data, zero if no spine.

Reimplemented from oomph::Node.

Definition at line 407 of file spines.h.

References oomph::Spine::ngeom_data(), and Spine_pt.

◆ ngeom_object()

unsigned oomph::SpineNode::ngeom_object ( ) const

inlinevirtual

Return the number of geometric objects, zero if no spine.

Reimplemented from oomph::Node.

Definition at line 420 of file spines.h.

References oomph::Spine::ngeom_object(), and Spine_pt.

◆ node_update()

void oomph::SpineNode::node_update ( const bool & update_all_time_levels_for_new_node = false )

virtual

Overload thet node update function, call the update function in the Node's SpineMesh.

////////////////////////////////////////////////////////////////

//////////////////////////////////////////////////////////////// Update function, call the update function in the Node's SpineMesh.

Reimplemented from oomph::Node.

Definition at line 44 of file spines.cc.

References oomph::Node::Aux_node_update_fct_pt, Spine_mesh_pt, and oomph::SpineMesh::spine_node_update().

◆ node_update_fct_id()

unsigned& oomph::SpineNode::node_update_fct_id ( )

inline

Access function to ID of node update function (within specific mesh)

Definition at line 384 of file spines.h.

References Node_update_fct_id.

Referenced by oomph::BrethertonSpineMesh< ELEMENT, INTERFACE_ELEMENT >::BrethertonSpineMesh(), oomph::ChannelSpineMesh< ELEMENT >::build_channel_spine_mesh(), oomph::TwoLayerSpineMesh< ELEMENT >::build_two_layer_mesh(), oomph::BrethertonSpineMesh< ELEMENT, INTERFACE_ELEMENT >::spine_node_update(), and oomph::TwoLayerSpineMesh< ELEMENT >::spine_node_update().

◆ spine_mesh_pt()

SpineMesh*& oomph::SpineNode::spine_mesh_pt ( )

inline

Access function to Pointer to SpineMesh that this node is a part of and which implements the node update function(s)

Definition at line 391 of file spines.h.

References Spine_mesh_pt.

Referenced by oomph::BrethertonSpineMesh< ELEMENT, INTERFACE_ELEMENT >::BrethertonSpineMesh(), oomph::ChannelSpineMesh< ELEMENT >::build_channel_spine_mesh(), oomph::HorizontalSingleLayerSpineMesh< ELEMENT >::build_horizontal_single_layer_mesh(), oomph::SingleLayerCubicSpineMesh< ELEMENT >::build_single_layer_mesh(), oomph::SingleLayerSpineMesh< ELEMENT >::build_single_layer_mesh(), and oomph::TwoLayerSpineMesh< ELEMENT >::build_two_layer_mesh().

◆ spine_pt()

Spine*& oomph::SpineNode::spine_pt ( )

inline

Access function to spine.

Definition at line 372 of file spines.h.

References Spine_pt.

Member Data Documentation

◆ Fraction

double oomph::SpineNode::Fraction

private

Private double that represents the fixed fraction along the spine.

Definition at line 334 of file spines.h.

Referenced by fraction().

◆ Node_update_fct_id

unsigned oomph::SpineNode::Node_update_fct_id

private

ID of node update function (within specific mesh – useful if there are multiple node update functions, e.g. in two-layer problems.

Definition at line 342 of file spines.h.

Referenced by node_update_fct_id().

◆ Spine_mesh_pt

SpineMesh* oomph::SpineNode::Spine_mesh_pt

private

Pointer to SpineMesh that this node is a part of. (The mesh implements the node update function(s))

Definition at line 338 of file spines.h.

Referenced by node_update(), and spine_mesh_pt().

◆ Spine_pt

Spine* oomph::SpineNode::Spine_pt

private

Private internal data pointer to a spine.

Definition at line 331 of file spines.h.

Referenced by all_geom_data_pt(), all_geom_object_pt(), h(), ngeom_data(), ngeom_object(), and spine_pt().

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

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SpineNode() [1/2]

◆ SpineNode() [2/2]

Member Function Documentation

◆ all_geom_data_pt()

◆ all_geom_object_pt()

◆ fraction()

◆ h()

◆ ngeom_data()

◆ ngeom_object()

◆ node_update()

◆ node_update_fct_id()

◆ spine_mesh_pt()

◆ spine_pt()

Member Data Documentation

◆ Fraction

◆ Node_update_fct_id

◆ Spine_mesh_pt

◆ Spine_pt