Force.hpp File Reference

The Force class defines corresponding force terms type. Note that all the forces are gsl matrices with a size of (3,1). More...

#include <sstream>
#include <ostream>
#include <omp.h>
#include <iomanip>
#include <algorithm>
#include "linalg/Linear_algebra.hpp"
#include "Parameters.hpp"

Go to the source code of this file.

Classes
class	Force
	This class includes 7 components in calculating force exerted on vertrices: force due to membrane bending, area constraint, volume constraint, membrane thickness constraint, lipid tilting, regularization, and spline. More...

Functions
Force	operator+ (const Force &lhs, const Force &rhs)
	This code defines a binary operator + for the Force class. The operator takes two const references to Force objects (lhs and rhs) as its arguments.
Force &	operator+= (Force &lhs, const Force &rhs)
	This code defines a compound assignment operator += for the Force class. The operator takes a reference to a Force object (lhs) and a const reference to another Force object (rhs) as its arguments. It modifies the lhs object by adding the components of the rhs object to it.

Detailed Description

The Force class defines corresponding force terms type. Note that all the forces are gsl matrices with a size of (3,1).

Author

Y Ying (yying.nosp@m.7@jh.nosp@m..edu)

Date

2023-01-05

Copyright

Copyright (c) 2023

Function Documentation

operator+()

Force operator+	(	const Force &	lhs,
		const Force &	rhs
	)

This code defines a binary operator + for the Force class. The operator takes two const references to Force objects (lhs and rhs) as its arguments.

Parameters

lhs
rhs

Returns

Force

operator+=()

Force & operator+=	(	Force &	lhs,
		const Force &	rhs
	)

This code defines a compound assignment operator += for the Force class. The operator takes a reference to a Force object (lhs) and a const reference to another Force object (rhs) as its arguments. It modifies the lhs object by adding the components of the rhs object to it.

Parameters

lhs
rhs

Returns

Force&