NURBS3DCurve Class Reference

A NURBS 3D curve. More...

Inheritance diagram for NURBS3DCurve:
Collaboration diagram for NURBS3DCurve:

Public Member Functions

 NURBS3DCurve (const NURBSbasis &basis, const List< vector > &CPs, const List< scalar > &weights, const scalarField &u, const label nPts, const word name="NURBS3DCurve")
 Construct from control points, weights and basis order and parametric coordinates. More...
 
 NURBS3DCurve (const NURBSbasis &basis, const List< vector > &CPs, const List< scalar > &weights, const label nPts, const word name="NURBS3DCurve")
 Construct from control points, weights and basis order. More...
 
 NURBS3DCurve (const NURBSbasis &basis, const List< vector > &CPs, const label nPts, const word name="NURBS3DCurve")
 Construct from control points and basis order. More...
 
 NURBS3DCurve (const NURBS3DCurve &)
 Construct as copy. More...
 
 ~NURBS3DCurve ()=default
 Destructor. More...
 
void setNrm3DOrientation (const vector &givenNrm, const vector &givenTan)
 Take a given normal and use to determine if NURBS normals should be reversed. Computation taken from u = 0. More...
 
void setNrm2DOrientation (const vector &givenNrm, const scalar zVal)
 
void flipNrmOrientation ()
 Flip the orientation of the nrm. More...
 
void setCPs (const List< vector > &CPs)
 Set CPs. More...
 
void setWeights (const List< scalar > &weights)
 Set weights. More...
 
void setName (const word &name)
 Set name. More...
 
void buildCurve ()
 Build curve. More...
 
void invert ()
 Invert CPs order and re-build curve. More...
 
void insertKnot (const scalarField &oldKnots, const scalar uBar, const label kInsert)
 Insert a knot by re-computing the control points. More...
 
void makeEquidistant (const label lenAcc=25, const label maxIter=10, const label spacingCorrInterval=-1, const scalar tolerance=1.e-5)
 Make curve points equidistant in cartesian space. More...
 
vector curvePoint (const scalar u) const
 Curve point cartesian coordinates at ui. More...
 
scalar findClosestCurvePoint (const vector &targetPoint, const label maxIter=1000, const scalar tolerance=1.e-13)
 Find curve point which is closest to given point using Newton-Raphson. Returns the param coordinate. More...
 
scalar findClosestCurvePoint (const vector &targetPoint, const scalar initGuess, const label maxIter=1000, const scalar tolerance=1.e-13)
 Find curve point which is closest to given point using Newton-Raphson. Returns the param coordinate. More...
 
const vector nrm3D (const vector &refTan, const scalar u) const
 Find the normal to the curve, with the option of forcing a z-plane. More...
 
const vector nrm2D (const scalar zVal, const scalar u) const
 
scalarList genEquidistant (const label nPts=100, const label lenAcc=25, const label maxIter=10, const label spacingCorrInterval=-1, const scalar tolerance=1.e-5)
 Generate points on the curve which are evenly spaced in cartesian coordinate distances. More...
 
bool checkRange (const scalar u, const label CPI, const label degree) const
 Check if given parametric coordinate u and CP are linked. More...
 
bool checkRange (const scalar u, const label CPI) const
 
scalar length (const label uIStart, const label uIEnd) const
 Calculate Length from starting to ending indices via computational evaluation using trapezoid rule. More...
 
scalar length (const scalar uStart, const scalar uEnd, const label nPts) const
 Calculate length from starting to ending parametric coordinates via computational evaluation using trapezoid rule. More...
 
scalar length () const
 Calculate length for the entire curve length. More...
 
vector curveDerivativeU (const scalar u) const
 Curve derivative wrt u at point ui. More...
 
vector curveDerivativeUU (const scalar u) const
 Curve second derivative wrt u at point ui. More...
 
scalar curveDerivativeCP (const scalar u, const label CPI)
 Curve derivative wrt b at point ui: scalar since dx/dX = dy/dY = dz/dZ. More...
 
vector curveDerivativeWeight (const scalar u, const label CPI)
 Curve derivative wrt CPII at point u. More...
 
scalar lengthDerivativeU (const scalar uStart, const scalar uEnd, const label nPts)
 Calculate length from starting to ending indices via computational evaluation using trapezoid rule. More...
 
const NURBSbasisgetBasisFunction () const
 Get basis function. More...
 
const List< vector > & getCPs () const
 Get CPs. More...
 
const List< scalar > & getWeights () const
 Get weights. More...
 
const List< scalar > & getParametricCoordinates () const
 Get parametric coordinates. More...
 
const wordgetName () const
 Get name. More...
 
label nrmOrientation () const
 Return the nrm sgn relation to the u=0 nrm. More...
 
const vectorgivenInitNrm () const
 Return the initial normal given to compare to the Curve's normals. More...
 
void write ()
 Write curve to file. More...
 
void write (const word fileName)
 
void write (const fileName dirName, const fileName fileName)
 
void writeWParses ()
 
void writeWParses (const word fileName)
 
void writeWParses (const fileName dirName, const fileName fileName)
 
- Public Member Functions inherited from Field< Type >
constexpr Field () noexcept
 Default construct. More...
 
 Field (const label len)
 Construct given size. More...
 
 Field (const label len, const Type &val)
 Construct given size and initial value. More...
 
 Field (const label len, const Foam::zero)
 Construct given size and initial values of zero. More...
 
 Field (const Foam::one, const Type &val)
 Construct with length=1, copying the value as the only content. More...
 
 Field (const Foam::one, Type &&val)
 Construct with length=1, moving the value as the only content. More...
 
 Field (const Foam::one, const Foam::zero)
 Construct with length=1, initializing content to zero. More...
 
 Field (const Field< Type > &fld)
 Copy construct. More...
 
 Field (const UList< Type > &list)
 Copy construct from UList<Type> More...
 
template<class Addr >
 Field (const IndirectListBase< Type, Addr > &list)
 Copy construct from IndirectList. More...
 
 Field (Field< Type > &&fld) noexcept
 Move construct from Field. More...
 
 Field (List< Type > &&list) noexcept
 Move construct from List. More...
 
template<int SizeMin>
 Field (DynamicList< Type, SizeMin > &&list)
 Move construct from DynamicList. More...
 
 Field (const UList< Type > &mapF, const labelUList &mapAddressing)
 Construct by 1 to 1 mapping from the given field. More...
 
 Field (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing)
 Construct by 1 to 1 mapping from the given tmp field. More...
 
 Field (const UList< Type > &mapF, const labelListList &mapAddressing, const scalarListList &weights)
 Construct by interpolative mapping from the given field. More...
 
 Field (const tmp< Field< Type >> &tmapF, const labelListList &mapAddressing, const scalarListList &weights)
 Construct by interpolative mapping from the given tmp field. More...
 
 Field (const UList< Type > &mapF, const FieldMapper &map, const bool applyFlip=true)
 Construct by mapping from the given field. More...
 
 Field (const UList< Type > &mapF, const FieldMapper &map, const Type &defaultValue, const bool applyFlip=true)
 Construct by mapping from the given field. More...
 
 Field (const UList< Type > &mapF, const FieldMapper &map, const UList< Type > &defaultValues, const bool applyFlip=true)
 Construct by mapping from the given field. More...
 
 Field (const tmp< Field< Type >> &tmapF, const FieldMapper &map, const bool applyFlip=true)
 Construct by mapping from the given tmp field. More...
 
 Field (const tmp< Field< Type >> &tmapF, const FieldMapper &map, const Type &defaultValue, const bool applyFlip=true)
 Construct by mapping from the given tmp field. Uses supplied uniform value for unmapped items. More...
 
 Field (const tmp< Field< Type >> &tmapF, const FieldMapper &map, const UList< Type > &defaultValues, const bool applyFlip=true)
 Construct by mapping from the given tmp field. Uses supplied values for unmapped items. More...
 
 Field (Field< Type > &fld, bool reuse)
 Copy construct or re-use as specified. More...
 
 Field (const tmp< Field< Type >> &tfld)
 Copy or move construct from tmp. More...
 
 Field (Istream &is)
 Construct from Istream. More...
 
 Field (const entry &e, const label len)
 Construct from a dictionary (primitive) entry. More...
 
 Field (const word &key, const dictionary &dict, const label len, IOobjectOption::readOption readOpt=IOobjectOption::MUST_READ)
 Lookup of a primitive dictionary entry by (literal) name and assign its contents to this. The behaviour largely as described in assign(): More...
 
tmp< Field< Type > > clone () const
 Clone. More...
 
void assign (const entry &e, const label len)
 Assign from a primitive dictionary entry with the following behaviour: More...
 
bool assign (const word &key, const dictionary &dict, const label len, IOobjectOption::readOption readOpt=IOobjectOption::MUST_READ)
 Lookup a primitive dictionary entry by (literal) name and assign its contents to this (behaviour as described above). More...
 
void map (const UList< Type > &mapF, const labelUList &mapAddressing)
 1 to 1 map from the given field More...
 
void map (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing)
 1 to 1 map from the given tmp field More...
 
void map (const UList< Type > &mapF, const labelListList &mapAddressing, const scalarListList &weights)
 Interpolative map from the given field. More...
 
void map (const tmp< Field< Type >> &tmapF, const labelListList &mapAddressing, const scalarListList &weights)
 Interpolative map from the given tmp field. More...
 
void map (const UList< Type > &mapF, const FieldMapper &map, const bool applyFlip=true)
 Map from the given field. More...
 
void map (const tmp< Field< Type >> &tmapF, const FieldMapper &map, const bool applyFlip=true)
 Map from the given tmp field. More...
 
void autoMap (const FieldMapper &map, const bool applyFlip=true)
 Map from self. More...
 
void rmap (const UList< Type > &mapF, const labelUList &mapAddressing)
 1 to 1 reverse-map from the given field More...
 
void rmap (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing)
 1 to 1 reverse-map from the given tmp field More...
 
void rmap (const UList< Type > &mapF, const labelUList &mapAddressing, const UList< scalar > &weights)
 Interpolative reverse map from the given field. More...
 
void rmap (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing, const UList< scalar > &weights)
 Interpolative reverse map from the given tmp field. More...
 
void negate ()
 Inplace negate this field (negative). More...
 
void normalise ()
 Inplace normalise this field. Generally a no-op except for vector fields. More...
 
tmp< Field< cmptType > > component (const direction) const
 Return a component field of the field. More...
 
void replace (const direction, const UList< cmptType > &)
 Replace a component field of the field. More...
 
void replace (const direction, const tmp< Field< cmptType >> &)
 Replace a component field of the field. More...
 
void replace (const direction, const cmptType &)
 Replace a component field of the field. More...
 
void clamp_min (const Type &lower)
 Impose lower (floor) clamp on the field values (in-place) More...
 
void clamp_max (const Type &upper)
 Impose upper (ceiling) clamp on the field values (in-place) More...
 
void clamp_range (const Type &lower, const Type &upper)
 Clamp field values (in-place) to the specified range. More...
 
void clamp_range (const MinMax< Type > &range)
 Clamp field values (in-place) to the specified range. More...
 
template<class VSForm >
VSForm block (const label start) const
 
tmp< Field< Type > > T () const
 Return the field transpose (only defined for second rank tensors) More...
 
void writeEntry (const word &keyword, Ostream &os) const
 Write the field as a dictionary entry. More...
 
SubField< Type > slice (const label pos, label len=-1)
 Return SubField slice (non-const access) - no range checking. More...
 
const SubField< Type > slice (const label pos, label len=-1) const
 Return SubField slice (const access) - no range checking. More...
 
SubField< Type > slice (const labelRange &range)
 Return SubField slice (non-const access) - with range checking. More...
 
const SubField< Type > slice (const labelRange &range) const
 Return SubField slice (const access) - with range checking. More...
 
void operator= (const Field< Type > &)
 Copy assignment. More...
 
void operator= (const tmp< Field< Type >> &)
 
void operator= (const UList< Type > &rhs)
 
void operator= (const SubField< Type > &rhs)
 
template<class Addr >
void operator= (const IndirectListBase< Type, Addr > &rhs)
 Copy assign from IndirectList. More...
 
void operator= (Field< Type > &&rhs)
 Move assignment. More...
 
void operator= (List< Type > &&rhs)
 
template<int SizeMin>
void operator= (DynamicList< Type, SizeMin > &&rhs)
 
void operator= (const Type &val)
 Assign entries to the given value. More...
 
void operator= (const Foam::zero)
 Assign entries to zero. More...
 
template<class Form , class Cmpt , direction nCmpt>
void operator= (const VectorSpace< Form, Cmpt, nCmpt > &)
 
void operator+= (const UList< Type > &)
 
void operator+= (const tmp< Field< Type >> &)
 
void operator-= (const UList< Type > &)
 
void operator-= (const tmp< Field< Type >> &)
 
void operator*= (const UList< scalar > &)
 
void operator*= (const tmp< Field< scalar >> &)
 
void operator/= (const UList< scalar > &)
 
void operator/= (const tmp< Field< scalar >> &)
 
void operator+= (const Type &)
 
void operator-= (const Type &)
 
void operator*= (const scalar &)
 
void operator/= (const scalar &)
 
template<class Type>
void operator= (const tmp< Field > &rhs)
 
template<>
void normalise ()
 
template<>
void normalise ()
 
template<>
void normalise ()
 Inplace normalise (float) vector field. More...
 
template<>
void normalise ()
 Inplace normalise (double) vector field. More...
 
- Public Member Functions inherited from FieldBase
constexpr FieldBase () noexcept
 Default construct. More...
 
- Public Member Functions inherited from refCount
constexpr refCount () noexcept
 Default construct, initializing count to 0. More...
 
int use_count () const noexcept
 Return the current reference count. More...
 
bool unique () const noexcept
 Return true if the reference count is zero. More...
 
void operator++ () noexcept
 Increment the reference count. More...
 
void operator++ (int) noexcept
 Increment the reference count. More...
 
void operator-- () noexcept
 Decrement the reference count. More...
 
void operator-- (int) noexcept
 Decrement the reference count. More...
 
- Public Member Functions inherited from List< Type >
constexpr List () noexcept
 Default construct. More...
 
 List (const label len)
 Construct with given size. More...
 
 List (const label len, const Type &val)
 Construct with given size and value for all elements. More...
 
 List (const label len, const Foam::zero)
 Construct with given size initializing all elements to zero. More...
 
 List (const Foam::one, const Type &val)
 Construct with length=1, copying the value as the only content. More...
 
 List (const Foam::one, Type &&val)
 Construct with length=1, moving the value as the only content. More...
 
 List (const Foam::one, const Foam::zero)
 Construct with length=1, initializing content to zero. More...
 
 List (const List< Type > &list)
 Copy construct from list. More...
 
 List (const UList< Type > &list)
 Copy construct contents from list. More...
 
 List (List< Type > &list, bool reuse)
 Construct as copy or re-use as specified. More...
 
 List (const UList< Type > &list, const labelUList &indices)
 Copy construct subset of list. More...
 
 List (const UList< Type > &list, const FixedList< label, N > &indices)
 Copy construct subset of list. More...
 
 List (const FixedList< Type, N > &list)
 Construct as copy of FixedList<T, N> More...
 
 List (const PtrList< Type > &list)
 Construct as copy of PtrList<T> More...
 
 List (const IndirectListBase< Type, Addr > &list)
 Construct as copy of IndirectList contents. More...
 
 List (std::initializer_list< Type > list)
 Construct from an initializer list. More...
 
 List (List< Type > &&list) noexcept
 Move construct from List. More...
 
 List (DynamicList< Type, SizeMin > &&list)
 Move construct from DynamicList. More...
 
 List (Istream &is)
 Construct from Istream. More...
 
 List (const SLList< Type > &list)
 Copy construct from SLList. More...
 
autoPtr< List< Type > > clone () const
 Clone. More...
 
 ~List ()
 Destructor. More...
 
void clear ()
 Clear the list, i.e. set size to zero. More...
 
void resize (const label len)
 Adjust allocated size of list. More...
 
void resize (const label len, const Type &val)
 Adjust allocated size of list and set val for new elements. More...
 
void resize (const label newLen)
 
void resize_fill (const label len, const Type &val)
 Adjust allocated size of list and set val for all elements. More...
 
void resize_nocopy (const label len)
 Adjust allocated size of list without necessarily. More...
 
void resize_unsafe (const label len) noexcept
 Change the addressed list size directly without affecting any memory management (advanced usage). More...
 
void setSize (const label n)
 Alias for resize() More...
 
void setSize (const label n, const Type &val)
 Alias for resize() More...
 
void transfer (List< Type > &list)
 Transfer the contents of the argument List into this list and annul the argument list. More...
 
void transfer (DynamicList< Type, SizeMin > &list)
 Transfer the contents of the argument List into this list and annul the argument list. More...
 
Type & newElmt (const label i)
 Return subscript-checked element of UList and resizing the list if required. More...
 
Type & emplace_back (Args &&... args)
 Construct an element at the end of the list, return reference to the new list element. More...
 
void push_back (const Type &val)
 Append an element at the end of the list. More...
 
void push_back (Type &&val)
 Move append an element at the end of the list. More...
 
void push_back (const UList< Type > &list)
 Append a List to the end of this list. More...
 
void push_back (const IndirectListBase< Type, Addr > &list)
 Append IndirectList contents at the end of this list. More...
 
label push_uniq (const Type &val)
 Append an element if not already in the list. More...
 
void pop_back (label n=1)
 Reduce size by 1 or more elements. Can be called on an empty list. More...
 
void operator= (const UList< Type > &list)
 Assignment to UList operator. Takes linear time. More...
 
void operator= (const List< Type > &list)
 Assignment operator. Takes linear time. More...
 
void operator= (const IndirectListBase< Type, Addr > &list)
 Assignment from IndirectList. Takes linear time. More...
 
void operator= (const FixedList< Type, N > &list)
 Copy assignment from FixedList. More...
 
void operator= (std::initializer_list< Type > list)
 Assignment to an initializer list. More...
 
void operator= (const Type &val)
 Assignment of all entries to the given value. More...
 
void operator= (const Foam::zero)
 Assignment of all entries to zero. More...
 
void operator= (List< Type > &&list)
 Move assignment. Takes constant time. More...
 
void operator= (DynamicList< Type, SizeMin > &&list)
 Move assignment. Takes constant time. More...
 
void operator= (const SLList< Type > &list)
 Copy assign from SLList in linear time. More...
 
IstreamreadList (Istream &is)
 Read List from Istream, discarding contents of existing List. More...
 
void shallowCopy (const UList< Type > &)=delete
 No shallowCopy permitted. More...
 
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type set (const label i, bool val=true)
 A bitSet::set() method for a list of bool. More...
 
void append (const Type &val)
 Append an element at the end of the list. More...
 
void append (Type &&val)
 Move append an element at the end of the list. More...
 
void append (const UList< Type > &list)
 Append a List to the end of this list. More...
 
void append (const IndirectListBase< Type, Addr > &list)
 Append IndirectList contents at the end of this list. More...
 
label appendUniq (const Type &val)
 Same as push_uniq() More...
 
- Public Member Functions inherited from UList< Type >
label size () const noexcept
 The number of elements in the container. More...
 
void writeEntry (const word &keyword, Ostream &os) const
 Write the List as a dictionary entry with keyword. More...
 
void operator= (const Type &val)
 Assignment of all entries to the given value. More...
 
void operator= (const Foam::zero)
 Assignment of all entries to zero. More...
 
 UList (const UList< Type > &)=default
 Copy construct. More...
 
constexpr UList () noexcept
 Default construct, zero-sized and nullptr. More...
 
 UList (Type *__restrict__ v, const label len) noexcept
 Construct from components. More...
 
label fcIndex (const label i) const noexcept
 The forward circular index. The next index in the list which returns to the first at the end of the list. More...
 
label rcIndex (const label i) const noexcept
 The reverse circular index. The previous index in the list which returns to the last at the beginning of the list. More...
 
const Type & fcValue (const label i) const
 Return forward circular value (ie, next value in the list) More...
 
Type & fcValue (const label i)
 Return forward circular value (ie, next value in the list) More...
 
const Type & rcValue (const label i) const
 Return reverse circular value (ie, previous value in the list) More...
 
Type & rcValue (const label i)
 Return reverse circular value (ie, previous value in the list) More...
 
const Type * cdata () const noexcept
 Return pointer to the underlying array serving as data storage. More...
 
Type * data () noexcept
 Return pointer to the underlying array serving as data storage. More...
 
const char * cdata_bytes () const noexcept
 Return pointer to the underlying array serving as data storage,. More...
 
char * data_bytes () noexcept
 Return pointer to the underlying array serving as data storage,. More...
 
Type & front ()
 Access first element of the list, position [0]. More...
 
const Type & front () const
 Access first element of the list. More...
 
Type & back ()
 Access last element of the list, position [size()-1]. More...
 
const Type & back () const
 Access last element of the list, position [size()-1]. More...
 
std::streamsize size_bytes () const noexcept
 Number of contiguous bytes for the List data. More...
 
std::streamsize byteSize () const
 Number of contiguous bytes for the List data, runtime FatalError if type is not contiguous. More...
 
void checkStart (const label start) const
 Check start is within valid range [0,size) More...
 
void checkSize (const label size) const
 Check size is within valid range [0,size]. More...
 
void checkRange (const label start, const label len) const
 Check that start and length define a valid range. More...
 
void checkIndex (const label i) const
 Check index is within valid range [0,size) More...
 
bool uniform () const
 True if all entries have identical values, and list is non-empty. More...
 
bool contains (const Type &val) const
 True if the value is contained in the list. More...
 
bool contains (const Type &val, label pos, label len=-1) const
 Is the value contained in the list? More...
 
label find (const Type &val) const
 Find index of the first occurrence of the value. More...
 
label find (const Type &val, label pos, label len=-1) const
 Find index of the first occurrence of the value. More...
 
label rfind (const Type &val, label pos=-1) const
 Find index of the last occurrence of the value. More...
 
void moveFirst (const label i)
 Move element to the first position. More...
 
void moveLast (const label i)
 Move element to the last position. More...
 
void swapFirst (const label i)
 Swap element with the first element. Fatal on an empty list. More...
 
void swapLast (const label i)
 Swap element with the last element. Fatal on an empty list. More...
 
void shallowCopy (Type *__restrict__ ptr, const label len) noexcept
 Copy the pointer and size. More...
 
void shallowCopy (const UList< Type > &list) noexcept
 Copy the pointer and size held by the given UList. More...
 
void deepCopy (const UList< Type > &list)
 Copy elements of the given UList. Sizes must match! More...
 
void deepCopy (const IndirectListBase< Type, Addr > &list)
 Copy elements of the given indirect list. Sizes must match! More...
 
SubList< Type > slice (const label pos, label len=-1)
 Return SubList slice (non-const access) - no range checking. More...
 
const SubList< Type > slice (const label pos, label len=-1) const
 Return SubList slice (const access) - no range checking. More...
 
SubList< Type > slice (const labelRange &range)
 Return SubList slice (non-const access) - with range checking. More...
 
const SubList< Type > slice (const labelRange &range) const
 Return SubList slice (const access) - with range checking. More...
 
Type & operator[] (const label i)
 Return element of UList. More...
 
const Type & operator[] (const label i) const
 Return element of constant UList. More...
 
const bool & operator[] (const label i) const
 
UPstream::commsStructoperator[] (const label procID)
 
const UPstream::commsStructoperator[] (const label procID) const
 
Foam::UPstream::commsStructoperator[] (const label procID)
 
const Foam::UPstream::commsStructoperator[] (const label procID) const
 
 operator const Foam::List< Type > & () const
 Allow cast to a const List<T>&. More...
 
iterator begin () noexcept
 Return an iterator to begin traversing the UList. More...
 
iterator begin (const label i) noexcept
 Return iterator at offset i from begin, clamped to [0,size] range. More...
 
const_iterator begin () const noexcept
 Return const_iterator to begin traversing the constant UList. More...
 
const_iterator begin (const label i) const noexcept
 Return const_iterator at offset i from begin, clamped to [0,size] range. More...
 
iterator end () noexcept
 Return an iterator to end traversing the UList. More...
 
const_iterator end () const noexcept
 Return const_iterator to end traversing the constant UList. More...
 
const_iterator cbegin () const noexcept
 Return const_iterator to begin traversing the constant UList. More...
 
const_iterator cbegin (const label i) const noexcept
 Return const_iterator at offset i from begin, clamped to [0,size] range. More...
 
const_iterator cend () const noexcept
 Return const_iterator to end traversing the constant UList. More...
 
reverse_iterator rbegin ()
 Return reverse_iterator to begin reverse traversing the UList. More...
 
const_reverse_iterator rbegin () const
 Return const_reverse_iterator to begin reverse traversing the UList. More...
 
reverse_iterator rend ()
 Return reverse_iterator to end reverse traversing the UList. More...
 
const_reverse_iterator rend () const
 Return const_reverse_iterator to end reverse traversing the UList. More...
 
const_reverse_iterator crbegin () const
 Return const_reverse_iterator to begin reverse traversing the UList. More...
 
const_reverse_iterator crend () const
 Return const_reverse_iterator to end reverse traversing the UList. More...
 
bool empty () const noexcept
 True if List is empty (ie, size() is zero) More...
 
label capacity () const noexcept
 Size of the underlying storage. More...
 
void swap (UList< Type > &list) noexcept
 Swap content with another UList of the same type in constant time. More...
 
bool operator== (const UList< Type > &list) const
 Equality operation on ULists of the same type. More...
 
bool operator!= (const UList< Type > &list) const
 The opposite of the equality operation. Takes linear time. More...
 
bool operator< (const UList< Type > &list) const
 Compare two ULists lexicographically. Takes linear time. More...
 
bool operator> (const UList< Type > &list) const
 Compare two ULists lexicographically. Takes linear time. More...
 
bool operator<= (const UList< Type > &list) const
 Return true if !(a > b). Takes linear time. More...
 
bool operator>= (const UList< Type > &list) const
 Return true if !(a < b). Takes linear time. More...
 
IstreamreadList (Istream &is)
 Read List contents from Istream. More...
 
OstreamwriteList (Ostream &os, const label shortLen=0) const
 Write List, with line-breaks in ASCII when length exceeds shortLen. More...
 
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type test (const label i) const
 Test bool value at specified position, always false for out-of-range access. More...
 
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type get (const label i) const
 Return bool value at specified position, always false for out-of-range access. More...
 
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type unset (const label i)
 Unset the bool entry at specified position, always false for out-of-range access. More...
 
Type & first ()
 Access first element of the list, position [0]. More...
 
const Type & first () const
 Access first element of the list. More...
 
Type & last ()
 Access last element of the list, position [size()-1]. More...
 
const Type & last () const
 Access last element of the list, position [size()-1]. More...
 
bool found (const Type &val, label pos=0) const
 Same as contains() More...
 

Additional Inherited Members

- Public Types inherited from Field< Type >
typedef pTraits< Type >::cmptType cmptType
 Component type. More...
 
typedef SubField< Type > subField
 Declare type of subField. More...
 
- Public Types inherited from List< Type >
typedef SubList< Type > subList
 Declare type of subList. More...
 
- Public Types inherited from UList< Type >
typedef Type value_type
 The value type the list contains. More...
 
typedef Type * pointer
 The pointer type for non-const access to value_type items. More...
 
typedef const Type * const_pointer
 The pointer type for const access to value_type items. More...
 
typedef Type & reference
 The type used for storing into value_type objects. More...
 
typedef const Type & const_reference
 The type used for reading from constant value_type objects. More...
 
typedef Type * iterator
 Random access iterator for traversing a UList. More...
 
typedef const Type * const_iterator
 Random access iterator for traversing a UList. More...
 
typedef label size_type
 The type to represent the size of a UList. More...
 
typedef label difference_type
 The difference between iterator objects. More...
 
typedef std::reverse_iterator< iteratorreverse_iterator
 Reverse iterator (non-const access) More...
 
typedef std::reverse_iterator< const_iteratorconst_reverse_iterator
 Reverse iterator (const access) More...
 
- Static Public Member Functions inherited from Field< Type >
static const Field< Type > & null ()
 Return nullObject reference Field. More...
 
static autoPtr< Field< Type > > New (Istream &is)
 Return a pointer to a new Field created on freestore. More...
 
template<class Type2 >
static tmp< Field< Type > > NewCalculatedType (const Field< Type2 > &f)
 Return a pointer to a new calculatedFvPatchFieldField created on freestore without setting patchField values. More...
 
- Static Public Member Functions inherited from List< Type >
static const List< Type > & null ()
 Return a null List. More...
 
- Static Public Member Functions inherited from UList< Type >
static const UList< Type > & null ()
 Return a UList reference to a nullObject. More...
 
static constexpr label max_size () noexcept
 The size of the largest possible UList. More...
 
- Static Public Attributes inherited from FieldBase
static const char *const typeName
 Typename for Field. More...
 
static bool allowConstructFromLargerSize = false
 Permit read construct from a larger size. More...
 
- Protected Member Functions inherited from UList< Type >
void setAddressableSize (const label n) noexcept
 Set addressed size to be inconsistent with allocated storage. More...
 
void size (const label n)
 Older name for setAddressableSize. More...
 
void writeEntry (Ostream &os) const
 Write the UList with its compound type. More...
 
void writeEntry (Ostream &os) const
 Character list writeEntry. More...
 
void writeEntry (Ostream &os) const
 
labelRange validateRange (const labelRange &requestedRange) const
 Return a validated (start,size) subset range, which means that it always addresses a valid section of the list. More...
 
void fill_uniform (const Type &val)
 Assign all entries to the given value. More...
 
void fill_uniform (const Foam::zero)
 Assign all entries to zero. More...
 
UList< Type > & operator= (const UList< Type > &)=delete
 No copy assignment (default: shallow copy) More...
 
void operator= (const Foam::zero)
 Character list assign zero - avoids Foam::zero casting ambiguities. More...
 
void operator= (const Foam::zero)
 

Detailed Description

A NURBS 3D curve.

Source files

Definition at line 51 of file NURBS3DCurve.H.

Constructor & Destructor Documentation

◆ NURBS3DCurve() [1/4]

NURBS3DCurve ( const NURBSbasis basis,
const List< vector > &  CPs,
const List< scalar > &  weights,
const scalarField u,
const label  nPts,
const word  name = "NURBS3DCurve" 
)

Construct from control points, weights and basis order and parametric coordinates.

Definition at line 203 of file NURBS3DCurve.C.

◆ NURBS3DCurve() [2/4]

NURBS3DCurve ( const NURBSbasis basis,
const List< vector > &  CPs,
const List< scalar > &  weights,
const label  nPts,
const word  name = "NURBS3DCurve" 
)

Construct from control points, weights and basis order.

Uniform coordinate distribution is implied

Definition at line 229 of file NURBS3DCurve.C.

◆ NURBS3DCurve() [3/4]

NURBS3DCurve ( const NURBSbasis basis,
const List< vector > &  CPs,
const label  nPts,
const word  name = "NURBS3DCurve" 
)

Construct from control points and basis order.

Uniform coordinate distribution and unit weights are implied

Definition at line 255 of file NURBS3DCurve.C.

◆ NURBS3DCurve() [4/4]

NURBS3DCurve ( const NURBS3DCurve )

Construct as copy.

◆ ~NURBS3DCurve()

~NURBS3DCurve ( )
default

Destructor.

Member Function Documentation

◆ setNrm3DOrientation()

void setNrm3DOrientation ( const vector givenNrm,
const vector givenTan 
)

Take a given normal and use to determine if NURBS normals should be reversed. Computation taken from u = 0.

Definition at line 284 of file NURBS3DCurve.C.

References Foam::endl(), Foam::Info, Foam::tan(), and Foam::Zero.

Here is the call graph for this function:

◆ setNrm2DOrientation()

void setNrm2DOrientation ( const vector givenNrm,
const scalar  zVal 
)

Definition at line 310 of file NURBS3DCurve.C.

References Foam::endl(), Foam::Info, Foam::tan(), and Foam::Zero.

Here is the call graph for this function:

◆ flipNrmOrientation()

void flipNrmOrientation ( )

Flip the orientation of the nrm.

Definition at line 339 of file NURBS3DCurve.C.

◆ setCPs()

void setCPs ( const List< vector > &  CPs)

Set CPs.

Definition at line 352 of file NURBS3DCurve.C.

◆ setWeights()

void setWeights ( const List< scalar > &  weights)

Set weights.

Definition at line 358 of file NURBS3DCurve.C.

◆ setName()

void setName ( const word name)

Set name.

Definition at line 364 of file NURBS3DCurve.C.

References Foam::name().

Here is the call graph for this function:

◆ buildCurve()

void buildCurve ( )

Build curve.

Definition at line 370 of file NURBS3DCurve.C.

References NURBSbasis::basisValue(), NURBSbasis::degree(), forAll, UList< Type >::operator[](), and Foam::Zero.

Referenced by NURBS3DCurve::invert().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ invert()

void invert ( )

Invert CPs order and re-build curve.

Definition at line 401 of file NURBS3DCurve.C.

References NURBS3DCurve::buildCurve(), Foam::endl(), Foam::Info, UList< T >::size(), and Foam::Zero.

Here is the call graph for this function:

◆ insertKnot()

void insertKnot ( const scalarField oldKnots,
const scalar  uBar,
const label  kInsert 
)

Insert a knot by re-computing the control points.

The basis' insertKnot function must have beem called first to correctly provide the required info.

Definition at line 639 of file NURBS3DCurve.C.

References Foam::Zero.

◆ makeEquidistant()

void makeEquidistant ( const label  lenAcc = 25,
const label  maxIter = 10,
const label  spacingCorrInterval = -1,
const scalar  tolerance = 1.e-5 
)

Make curve points equidistant in cartesian space.

Definition at line 423 of file NURBS3DCurve.C.

◆ curvePoint()

vector curvePoint ( const scalar  u) const

Curve point cartesian coordinates at ui.

Definition at line 450 of file NURBS3DCurve.C.

References NURBSbasis::basisValue(), NURBSbasis::degree(), forAll, and Foam::Zero.

Here is the call graph for this function:

◆ findClosestCurvePoint() [1/2]

scalar findClosestCurvePoint ( const vector targetPoint,
const label  maxIter = 1000,
const scalar  tolerance = 1.e-13 
)

Find curve point which is closest to given point using Newton-Raphson. Returns the param coordinate.

Definition at line 477 of file NURBS3DCurve.C.

References Foam::bound(), Foam::endl(), forAll, Foam::mag(), and WarningInFunction.

Here is the call graph for this function:

◆ findClosestCurvePoint() [2/2]

scalar findClosestCurvePoint ( const vector targetPoint,
const scalar  initGuess,
const label  maxIter = 1000,
const scalar  tolerance = 1.e-13 
)

Find curve point which is closest to given point using Newton-Raphson. Returns the param coordinate.

Definition at line 547 of file NURBS3DCurve.C.

References Foam::bound(), Foam::endl(), Foam::mag(), and WarningInFunction.

Here is the call graph for this function:

◆ nrm3D()

const vector nrm3D ( const vector refTan,
const scalar  u 
) const

Find the normal to the curve, with the option of forcing a z-plane.

Definition at line 605 of file NURBS3DCurve.C.

References NURBS3DCurve::curveDerivativeU(), and Foam::Zero.

Here is the call graph for this function:

◆ nrm2D()

const vector nrm2D ( const scalar  zVal,
const scalar  u 
) const

Definition at line 624 of file NURBS3DCurve.C.

References NURBS3DCurve::curveDerivativeU(), Foam::mag(), Foam::tan(), and Foam::Zero.

Here is the call graph for this function:

◆ genEquidistant()

scalarList genEquidistant ( const label  nPts = 100,
const label  lenAcc = 25,
const label  maxIter = 10,
const label  spacingCorrInterval = -1,
const scalar  tolerance = 1.e-5 
)

Generate points on the curve which are evenly spaced in cartesian coordinate distances.

Definition at line 681 of file NURBS3DCurve.C.

References U, and Foam::Zero.

◆ checkRange() [1/2]

bool checkRange ( const scalar  u,
const label  CPI,
const label  degree 
) const

Check if given parametric coordinate u and CP are linked.

Definition at line 712 of file NURBS3DCurve.C.

◆ checkRange() [2/2]

bool checkRange ( const scalar  u,
const label  CPI 
) const

Definition at line 722 of file NURBS3DCurve.C.

References NURBSbasis::checkRange(), and NURBSbasis::degree().

Here is the call graph for this function:

◆ length() [1/3]

scalar length ( const label  uIStart,
const label  uIEnd 
) const

Calculate Length from starting to ending indices via computational evaluation using trapezoid rule.

Definition at line 729 of file NURBS3DCurve.C.

References NURBS3DCurve::curveDerivativeU(), forAll, NURBS3DCurve::length(), Foam::mag(), and Foam::Zero.

Here is the call graph for this function:

◆ length() [2/3]

scalar length ( const scalar  uStart,
const scalar  uEnd,
const label  nPts 
) const

Calculate length from starting to ending parametric coordinates via computational evaluation using trapezoid rule.

Definition at line 755 of file NURBS3DCurve.C.

References forAll, Foam::mag(), and Foam::Zero.

Here is the call graph for this function:

◆ length() [3/3]

scalar length ( ) const

Calculate length for the entire curve length.

Definition at line 785 of file NURBS3DCurve.C.

References UList< T >::size().

Referenced by NURBS3DCurve::length().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ curveDerivativeU()

vector curveDerivativeU ( const scalar  u) const

Curve derivative wrt u at point ui.

Definition at line 793 of file NURBS3DCurve.C.

References NURBSbasis::basisDerivativeU(), NURBSbasis::basisValue(), NURBSbasis::degree(), forAll, and Foam::Zero.

Referenced by NURBS3DCurve::length(), NURBS3DCurve::nrm2D(), and NURBS3DCurve::nrm3D().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ curveDerivativeUU()

vector curveDerivativeUU ( const scalar  u) const

Curve second derivative wrt u at point ui.

Definition at line 818 of file NURBS3DCurve.C.

References NURBSbasis::basisDerivativeU(), NURBSbasis::basisDerivativeUU(), NURBSbasis::basisValue(), NURBSbasis::degree(), forAll, and Foam::Zero.

Here is the call graph for this function:

◆ curveDerivativeCP()

scalar curveDerivativeCP ( const scalar  u,
const label  CPI 
)

Curve derivative wrt b at point ui: scalar since dx/dX = dy/dY = dz/dZ.

Definition at line 857 of file NURBS3DCurve.C.

References forAll, and Foam::Zero.

◆ curveDerivativeWeight()

vector curveDerivativeWeight ( const scalar  u,
const label  CPI 
)

Curve derivative wrt CPII at point u.

Definition at line 879 of file NURBS3DCurve.C.

References forAll, and Foam::Zero.

◆ lengthDerivativeU()

scalar lengthDerivativeU ( const scalar  uStart,
const scalar  uEnd,
const label  nPts 
)

Calculate length from starting to ending indices via computational evaluation using trapezoid rule.

Definition at line 905 of file NURBS3DCurve.C.

References forAll, Foam::mag(), and Foam::Zero.

Here is the call graph for this function:

◆ getBasisFunction()

const NURBSbasis& getBasisFunction ( ) const
inline

Get basis function.

Definition at line 384 of file NURBS3DCurve.H.

◆ getCPs()

const List<vector>& getCPs ( ) const
inline

Get CPs.

Definition at line 392 of file NURBS3DCurve.H.

◆ getWeights()

const List<scalar>& getWeights ( ) const
inline

Get weights.

Definition at line 400 of file NURBS3DCurve.H.

◆ getParametricCoordinates()

const List<scalar>& getParametricCoordinates ( ) const
inline

Get parametric coordinates.

Definition at line 408 of file NURBS3DCurve.H.

◆ getName()

const word& getName ( ) const
inline

Get name.

Definition at line 416 of file NURBS3DCurve.H.

◆ nrmOrientation()

label nrmOrientation ( ) const
inline

Return the nrm sgn relation to the u=0 nrm.

Definition at line 424 of file NURBS3DCurve.H.

◆ givenInitNrm()

const vector& givenInitNrm ( ) const
inline

Return the initial normal given to compare to the Curve's normals.

Definition at line 432 of file NURBS3DCurve.H.

◆ write() [1/3]

void write ( )

Write curve to file.

Definition at line 947 of file NURBS3DCurve.C.

◆ write() [2/3]

void write ( const word  fileName)

Definition at line 954 of file NURBS3DCurve.C.

References Foam::endl(), field(), forAll, and UPstream::master().

Here is the call graph for this function:

◆ write() [3/3]

void write ( const fileName  dirName,
const fileName  fileName 
)

Definition at line 1003 of file NURBS3DCurve.C.

References Foam::endl(), field(), forAll, and UPstream::master().

Here is the call graph for this function:

◆ writeWParses() [1/3]

void writeWParses ( )

Definition at line 1052 of file NURBS3DCurve.C.

◆ writeWParses() [2/3]

void writeWParses ( const word  fileName)

Definition at line 1059 of file NURBS3DCurve.C.

References Foam::endl(), field(), forAll, and UPstream::master().

Here is the call graph for this function:

◆ writeWParses() [3/3]

void writeWParses ( const fileName  dirName,
const fileName  fileName 
)

Definition at line 1110 of file NURBS3DCurve.C.

References Foam::endl(), field(), forAll, and UPstream::master().

Here is the call graph for this function:

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